]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/factoids.rb
factoids plugin: an empty trigger_pattern list means any word is a keyword
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / factoids.rb
index 78319fdcdfdfe3e960d9bc89d485966ff99ee846..f2dbeeafeca8568235458d64e2d6ab54560d8aa3 100644 (file)
@@ -28,17 +28,17 @@ class FactoidsPlugin < Plugin
       end
       meta = ""
       metadata = []
-      if fact[:who]
-        metadata << _("from %{who}" % fact.to_hash)
+      if @hash[:who]
+        metadata << _("from %{who}" % @hash)
       end
-      if fact[:when]
-        metadata << _("on %{when}" % fact.to_hash)
+      if @hash[:when]
+        metadata << _("on %{when}" % @hash)
       end
-      if fact[:where]
-        metadata << _("in %{where}" % fact.to_hash)
+      if @hash[:where]
+        metadata << _("in %{where}" % @hash)
       end
       unless metadata.empty?
-        meta << _(" [learnt %{data}]" % {:data => metadata.join(" ")})
+        meta << _(" [%{data}]" % {:data => metadata.join(" ")})
       end
       return fact+meta
     end
@@ -81,6 +81,20 @@ 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)\\s+.*:2",
+      "(this|that|a|the|an|all|both)\\s+(.*?)\\s+(is|are)\\s+.*:2",
+      "(.*)\\s+(is|are)\\s+.*",
+      "(.*?)\\s+(is|are)\\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::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")
+
   def initialize
     super
 
@@ -88,6 +102,7 @@ class FactoidsPlugin < Plugin
     @dir = File.join(@bot.botclass,"factoids")
     @filename = "factoids.rbot"
     @factoids = FactoidList.new
+    @triggers = Set.new
     begin
       read_factfile
     rescue
@@ -134,6 +149,7 @@ class FactoidsPlugin < Plugin
         :fname => fname
       })
     end
+    reset_triggers
   end
 
   def save
@@ -150,6 +166,58 @@ 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 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)
+  end
+
   def help(plugin, topic="")
     _("factoids plugin: learn that <factoid>, forget that <factoids>, facts about <words>")
   end
@@ -161,25 +229,54 @@ 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
+      })
     else
       @factoids << factoid
       @changed = true
       m.okay
+      fact(m, :index => @factoids.length.to_s)
+      parse_for_trigger(factoid)
     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 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 facts(m, params)
     total = @factoids.length
     if params[:words].empty?
@@ -187,11 +284,12 @@ class FactoidsPlugin < Plugin
     else
       rx = Regexp.new(params[:words].to_s, true)
       known = @factoids.grep(rx)
+      reply = []
       if known.empty?
-        m.reply _("I know nothing about %{words}" % params)
+        reply << _("I know nothing about %{words}" % params)
       else
         # TODO config
-        max_facts = 3
+        max_facts = 5
         len = known.length
         if len > max_facts
           m.reply _("%{len} out of %{total} facts refer to %{words}, I'll only show %{max}" % {
@@ -200,9 +298,26 @@ class FactoidsPlugin < Plugin
             :words => params[:words].to_s,
             :max => max_facts
           })
+          while known.length > max_facts
+            known.delete_one
+          end
         end
-        [max_facts, len].min.times { m.reply known.delete_one }
+        known.each { |f|
+          reply << long_fact(f)
+        }
       end
+      m.reply reply.join(" -- ")
+    end
+  end
+
+  def unreplied(m)
+    return if @bot.config['factoids.address'] and !m.address?
+    return if @factoids.empty?
+    return if @triggers.empty?
+    return unless m.message =~ /^(.*)\?\s*$/
+    query = $1.strip.downcase
+    if @triggers.include?(query)
+      facts(m, :words => query)
     end
   end
 
@@ -236,11 +351,7 @@ class FactoidsPlugin < Plugin
       fact = known.pick_one
       idx = @factoids.index(fact)+1
     end
-    m.reply _("fact #%{idx} of %{total}: %{fact}" % {
-      :idx => idx,
-      :total => total,
-      :fact => fact.to_s(:meta => true)
-    })
+    m.reply long_fact(fact, idx, total)
   end
 
   def edit_fact(m, params)
@@ -309,6 +420,7 @@ 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 'fact [about *words]'
 plugin.map 'fact :index', :requirements => { :index => /^#?\d+$/ }