X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=data%2Frbot%2Fplugins%2Ffactoids.rb;h=452efb98fef3fb8b7ff3eb2a3a69fc27f56d3383;hb=6cf365c49ce5fbe24c0a4ff0663550390b501fea;hp=8ceb28f4571c3d98dcf217a76c9c3d2a2ab698b9;hpb=34acfe3193a3603b4c6654dd23dacfef80ce1bc2;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git

diff --git a/data/rbot/plugins/factoids.rb b/data/rbot/plugins/factoids.rb
index 8ceb28f4..452efb98 100644
--- a/data/rbot/plugins/factoids.rb
+++ b/data/rbot/plugins/factoids.rb
@@ -20,8 +20,27 @@ class FactoidsPlugin < Plugin
       end
     end
 
-    def to_s
-      @hash[:fact]
+    def to_s(opts={})
+      show_meta = opts[:meta]
+      fact = @hash[:fact]
+      if !show_meta
+        return fact
+      end
+      meta = ""
+      metadata = []
+      if @hash[:who]
+        metadata << _("from %{who}" % @hash)
+      end
+      if @hash[:when]
+        metadata << _("on %{when}" % @hash)
+      end
+      if @hash[:where]
+        metadata << _("in %{where}" % @hash)
+      end
+      unless metadata.empty?
+        meta << _(" [%{data}]" % {:data => metadata.join(" ")})
+      end
+      return fact+meta
     end
 
     def [](*args)
@@ -46,7 +65,7 @@ class FactoidsPlugin < Plugin
     def index(f)
       fact = f.to_s
       return if fact.empty?
-      self.map { |f| f[:fact] }.index(fact)
+      self.map { |fs| fs[:fact] }.index(fact)
     end
 
     def delete(f)
@@ -62,13 +81,51 @@ class FactoidsPlugin < Plugin
     end
   end
 
+  # TODO default should be language-specific
+  Config.register Config::ArrayValue.new('factoids.trigger_pattern',
+    :default => [
+      "(this|that|a|the|an|all|both)\\s+(.*)\\s+(is|are|has|have|does|do)\\s+.*:2",
+      "(this|that|a|the|an|all|both)\\s+(.*?)\\s+(is|are|has|have|does|do)\\s+.*:2",
+      "(.*)\\s+(is|are|has|have|does|do)\\s+.*",
+      "(.*?)\\s+(is|are|has|have|does|do)\\s+.*",
+    ],
+    :on_change => Proc.new { |bot, v| bot.plugins['factoids'].reset_triggers },
+    :desc => "A list of regular expressions matching factoids where keywords can be identified. append ':n' if the keyword is defined by the n-th group instead of the first. if the list is empty, any word will be considered a keyword")
+  Config.register Config::ArrayValue.new('factoids.not_triggers',
+    :default => [
+      "this","that","the","a","right","who","what","why"
+    ],
+    :on_change => Proc.new { |bot, v| bot.plugins['factoids'].reset_triggers },
+    :desc => "A list of words that won't be set as keywords")
+  Config.register Config::BooleanValue.new('factoids.address',
+    :default => true,
+    :desc => "Should the bot reply with relevant factoids only when addressed with a direct question? If not, the bot will attempt to lookup foo if someone says 'foo?' in channel")
+  Config.register Config::ArrayValue.new('factoids.learn_pattern',
+    :default => [
+      ".*\\s+(is|are|has|have)\\s+.*"
+    ],
+    :on_change => Proc.new { |bot, v| bot.plugins['factoids'].reset_learn_patterns },
+    :desc => "A list of regular expressions matching factoids that the bot can learn. append ':n' if the factoid is defined by the n-th group instead of the whole match.")
+  Config.register Config::BooleanValue.new('factoids.listen_and_learn',
+    :default => false,
+    :desc => "Should the bot learn factoids from what is being said in chat? if true, phrases matching patterns in factoids.learn_pattern will tell the bot when a phrase can be learned")
+  Config.register Config::BooleanValue.new('factoids.silent_listen_and_learn',
+    :default => true,
+    :desc => "Should the bot be silent about the factoids he learns from the chat? If true, the bot will not declare what he learned every time he learns something from factoids.listen_and_learn being true")
+  Config.register Config::IntegerValue.new('factoids.search_results',
+    :default => 5,
+    :desc => "How many factoids to display at a time")
+
   def initialize
     super
 
     # TODO config
-    @dir = File.join(@bot.botclass,"factoids")
+    @dir = datafile
     @filename = "factoids.rbot"
     @factoids = FactoidList.new
+    @triggers = Set.new
+    @learn_patterns = []
+    reset_learn_patterns
     begin
       read_factfile
     rescue
@@ -115,6 +172,7 @@ class FactoidsPlugin < Plugin
         :fname => fname
       })
     end
+    reset_triggers
   end
 
   def save
@@ -131,8 +189,85 @@ class FactoidsPlugin < Plugin
     @changed = false
   end
 
+  def trigger_patterns_to_rx
+    return [] if @bot.config['factoids.trigger_pattern'].empty?
+    @bot.config['factoids.trigger_pattern'].inject([]) { |list, str|
+      s = str.dup
+      if s =~ /:(\d+)$/
+        idx = $1.to_i
+        s.sub!(/:\d+$/,'')
+      else
+        idx = 1
+      end
+      list << [/^#{s}$/iu, idx]
+    }
+  end
+
+  def learn_patterns_to_rx
+    return [] if @bot.config['factoids.learn_pattern'].empty?
+    @bot.config['factoids.learn_pattern'].inject([]) { |list, str|
+      s = str.dup
+      if s =~ /:(\d+)$/
+        idx = $1.to_i
+        s.sub!(/:\d+$/,'')
+      else
+        idx = 0
+      end
+      list << [/^#{s}$/iu, idx]
+    }
+  end
+
+  def parse_for_trigger(f, rx=nil)
+    if !rx
+      regs = trigger_patterns_to_rx
+    else
+      regs = rx
+    end
+    if regs.empty?
+      f.to_s.scan(/\w+/u)
+    else
+      regs.inject([]) { |list, a|
+        r = a.first
+        i = a.last
+        m = r.match(f.to_s)
+        if m
+          list << m[i].downcase
+        else
+          list
+        end
+      }
+    end
+  end
+
+  def reset_triggers
+    return unless @factoids
+    start_time = Time.now
+    rx = trigger_patterns_to_rx
+    triggers = @factoids.inject(Set.new) { |set, f|
+      found = parse_for_trigger(f, rx)
+      if found.empty?
+        set
+      else
+        set | found
+      end
+    }
+    debug "Triggers done in #{Time.now - start_time}"
+    @triggers.replace(triggers - @bot.config['factoids.not_triggers'])
+  end
+
+  def reset_learn_patterns
+    @learn_patterns.replace(learn_patterns_to_rx)
+  end
+
   def help(plugin, topic="")
-    _("factoids plugin: learn that <factoid>, forget that <factoids>, facts about <words>")
+    case plugin
+    when 'learn'
+      _("learn that <factoid> => learn a factoid")
+    when 'forget'
+      _("forget fact <#num> => forget factoid number #num ; forget about <factoid> => forget a factoid")
+    else
+      _("factoids plugin: learn that <factoid>, forget that <factoid>, facts about <words>")
+    end
   end
 
   def learn(m, params)
@@ -142,35 +277,135 @@ class FactoidsPlugin < Plugin
       :who => m.source.fullform,
       :where => m.channel.to_s
     )
-    if @factoids.index(factoid)
-      m.reply _("I already know that %{factoid}" % { :factoid => factoid })
+    if idx = @factoids.index(factoid)
+      m.reply _("I already know that %{factoid} [#%{idx}]" % {
+        :factoid => factoid,
+        :idx => idx
+      }) unless params[:silent]
     else
       @factoids << factoid
       @changed = true
-      m.okay
+      m.reply _("okay, learned fact #%{num}: %{fact}" % { :num => @factoids.length, :fact => @factoids.last}) unless params[:silent]
+      trigs = parse_for_trigger(factoid)
+      @triggers |= trigs unless trigs.empty?
     end
   end
 
   def forget(m, params)
-    factoid = params[:stuff].to_s
-    if @factoids.delete(factoid)
-      @changed = true
-      m.okay
+    if params[:index]
+      idx = params[:index].scan(/\d+/).first.to_i
+      total = @factoids.length
+      if idx <= 0 or idx > total
+        m.reply _("please select a fact number between 1 and %{total}" % { :total => total })
+        return
+      end
+      if factoid = @factoids.delete_at(idx-1)
+        m.reply _("I forgot that %{factoid}" % { :factoid => factoid })
+        @changed = true
+      else
+        m.reply _("I couldn't delete factoid %{idx}" % { :idx => idx })
+      end
     else
-      m.reply _("I didn't know that %{factoid}" % { :factoid => factoid })
+      factoid = params[:stuff].to_s
+      if @factoids.delete(factoid)
+        @changed = true
+        m.okay
+      else
+        m.reply _("I didn't know that %{factoid}" % { :factoid => factoid })
+      end
     end
   end
 
+  def short_fact(fact,index=nil,total=@factoids.length)
+    idx = index || @factoids.index(fact)+1
+    _("[%{idx}/%{total}] %{fact}" % {
+      :idx => idx,
+      :total => total,
+      :fact => fact.to_s(:meta => false)
+    })
+  end
+
+  def long_fact(fact,index=nil,total=@factoids.length)
+    idx = index || @factoids.index(fact)+1
+    _("fact #%{idx} of %{total}: %{fact}" % {
+      :idx => idx,
+      :total => total,
+      :fact => fact.to_s(:meta => true)
+    })
+  end
+
+  def words2rx(words)
+    # When looking for words we separate them with
+    # arbitrary whitespace, not whatever they came with
+    pre = words.map { |w| Regexp.escape(w)}.join("\\s+")
+    pre << '\b' if pre.match(/\b$/)
+    pre = '\b' + pre if pre.match(/^\b/)
+    return Regexp.new(pre, true)
+  end
+
   def facts(m, params)
-    if params[:words].empty?
-      m.reply _("I know %{count} facts" % { :count => @factoids.length })
+    total = @factoids.length
+    if params[:words].nil_or_empty? and params[:rx].nil_or_empty?
+      m.reply _("I know %{total} facts" % { :total => total })
     else
-      rx = Regexp.new(params[:words].to_s, true)
+      unless params.key? :words and not params[:words].empty?
+        rx = Regexp.new(params[:rx].to_s, true)
+      else
+        rx = words2rx(params[:words])
+      end
       known = @factoids.grep(rx)
+      reply = []
       if known.empty?
-        m.reply _("I know nothing about %{words}" % params)
+        if params.key? :words
+          reply << _("I know nothing about %{words}" % params)
+        else params.key? :rx
+          reply << _("I know nothing matching %{rx}" % params)
+        end
       else
-        m.reply known.join(" | "), :split_at => /\s+\|\s+/
+        max_facts = @bot.config['factoids.search_results']
+        len = known.length
+        if len > max_facts
+          m.reply _("%{len} out of %{total} facts refer to %{words}, I'll only show %{max}" % {
+            :len => len,
+            :total => total,
+            :words => params[:words].to_s,
+            :max => max_facts
+          })
+          while known.length > max_facts
+            known.delete_one
+          end
+        end
+        known.each { |f|
+          reply << short_fact(f)
+        }
+      end
+      m.reply reply.join(". "), :split_at => /\[\d+\/\d+\] /, :purge_split => false
+    end
+  end
+
+  def unreplied(m)
+    if m.message =~ /^(.*)\?\s*$/
+      return if @bot.config['factoids.address'] and !m.address?
+      return if @factoids.empty?
+      return if @triggers.empty?
+      query = $1.strip.downcase
+      if @triggers.include?(query)
+        words = query.split
+        words.instance_variable_set(:@string_value, query)
+        def words.to_s
+          @string_value
+        end
+        facts(m, :words => words)
+      end
+    else
+      return if m.address? # we don't learn stuff directed at us which is not an explicit learn command
+      return if !@bot.config['factoids.listen_and_learn'] or @learn_patterns.empty?
+      @learn_patterns.each do |pat, i|
+        g = pat.match(m.message)
+        if g and g[i]
+          learn(m, :stuff => g[i], :silent => @bot.config['factoids.silent_listen_and_learn'])
+          break
+        end
       end
     end
   end
@@ -195,7 +430,7 @@ class FactoidsPlugin < Plugin
         end
         known = @factoids
       else
-        rx = Regexp.new(params[:words].to_s, true)
+        rx = words2rx(params[:words])
         known = @factoids.grep(rx)
         if known.empty?
           m.reply _("I know nothing about %{words}" % params)
@@ -205,26 +440,7 @@ class FactoidsPlugin < Plugin
       fact = known.pick_one
       idx = @factoids.index(fact)+1
     end
-    meta = nil
-    metadata = []
-    if fact[:who]
-      metadata << _("from %{who}" % fact.to_hash)
-    end
-    if fact[:when]
-      metadata << _("on %{when}" % fact.to_hash)
-    end
-    if fact[:where]
-      metadata << _("in %{where}" % fact.to_hash)
-    end
-    unless metadata.empty?
-      meta = _(" [learnt %{data}]" % {:data => metadata.join(" ")})
-    end
-    m.reply _("fact #%{idx} of %{total}: %{fact}%{meta}" % {
-      :idx => idx,
-      :total => total,
-      :fact => fact,
-      :meta => meta
-    })
+    m.reply long_fact(fact, idx, total)
   end
 
   def edit_fact(m, params)
@@ -293,7 +509,9 @@ plugin.default_auth('import', false)
 
 plugin.map 'learn that *stuff'
 plugin.map 'forget that *stuff', :auth_path => 'edit'
+plugin.map 'forget fact :index', :requirements => { :index => /^#?\d+$/ }, :auth_path => 'edit'
 plugin.map 'facts [about *words]'
+plugin.map 'facts search *rx'
 plugin.map 'fact [about *words]'
 plugin.map 'fact :index', :requirements => { :index => /^#?\d+$/ }