X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=data%2Frbot%2Fplugins%2Ffactoids.rb;h=5f31191b25e0204ecaf267891417f684c905c959;hb=3d8bdf551aebdd4fa7ddb10fa8e824232dd4f82b;hp=f2dbeeafeca8568235458d64e2d6ab54560d8aa3;hpb=e7a0fa98cc6ca709be9b6f68ccd564a9ae502768;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git

diff --git a/data/rbot/plugins/factoids.rb b/data/rbot/plugins/factoids.rb
index f2dbeeaf..5f31191b 100644
--- a/data/rbot/plugins/factoids.rb
+++ b/data/rbot/plugins/factoids.rb
@@ -9,106 +9,138 @@
 #
 # Store (and retrieve) unstructured one-sentence factoids
 
-class FactoidsPlugin < Plugin
 
-  class Factoid
-    def initialize(hash)
-      @hash = hash.reject { |k, val| val.nil? or val.empty? rescue false }
-      raise ArgumentError, "no fact!" unless @hash[:fact]
-      if String === @hash[:when]
-        @hash[:when] = Time.parse @hash[:when]
-      end
+class ::Factoid
+  def initialize(hash)
+    @hash = hash.reject { |k, val| val.nil? or val.empty? rescue false }
+    raise ArgumentError, "no fact!" unless @hash[:fact]
+    if String === @hash[:when]
+      @hash[:when] = Time.parse @hash[:when]
     end
+  end
 
-    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
+  def to_s(opts={})
+    show_meta = opts[:meta]
+    fact = @hash[:fact]
+    if !show_meta
+      return fact
     end
-
-    def [](*args)
-      @hash[*args]
+    meta = ""
+    metadata = []
+    if @hash[:who]
+      metadata << _("from %{who}" % @hash)
     end
-
-    def []=(*args)
-      @hash.send(:[]=,*args)
+    if @hash[:when]
+      metadata << _("on %{when}" % @hash)
     end
-
-    def to_hsh
-      return @hash
+    if @hash[:where]
+      metadata << _("in %{where}" % @hash)
+    end
+    unless metadata.empty?
+      meta << _(" [%{data}]" % {:data => metadata.join(" ")})
     end
-    alias :to_hash :to_hsh
+    return fact+meta
   end
 
-  class FactoidList < ArrayOf
-    def initialize(ar=[])
-      super(Factoid, ar)
-    end
+  def [](*args)
+    @hash[*args]
+  end
 
-    def index(f)
-      fact = f.to_s
-      return if fact.empty?
-      self.map { |f| f[:fact] }.index(fact)
-    end
+  def []=(*args)
+    @hash.send(:[]=,*args)
+  end
 
-    def delete(f)
-      idx = index(f)
-      return unless idx
-      self.delete_at(idx)
-    end
+  def to_hsh
+    return @hash
+  end
+  alias :to_hash :to_hsh
+end
 
-    def grep(x)
-      self.find_all { |f|
-        x === f[:fact]
-      }
-    end
+class ::FactoidList < ArrayOf
+  def initialize(ar=[])
+    super(Factoid, ar)
+  end
+
+  def index(f)
+    fact = f.to_s
+    return if fact.empty?
+    self.map { |fs| fs[:fact] }.index(fact)
+  end
+
+  def delete(f)
+    idx = index(f)
+    return unless idx
+    self.delete_at(idx)
   end
 
+  def grep(x)
+    self.find_all { |f|
+      x === f[:fact]
+    }
+  end
+end
+
+class FactoidsPlugin < Plugin
   # 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+.*",
+      "(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")
-    @filename = "factoids.rbot"
-    @factoids = FactoidList.new
     @triggers = Set.new
-    begin
-      read_factfile
-    rescue
-      debug $!
+    @learn_patterns = []
+
+    @factoids = @registry[:factoids]
+    unless @factoids
+      @factoids = FactoidList.new
+
+      @dir = datafile
+      @filename = "factoids.rbot"
+      debug "migrate from existing factoids #{@dir}/#{@filename}"
+      reset_learn_patterns
+      begin
+        read_factfile
+      rescue
+        debug $!
+      end
+      @changed = true
+    else
+      reset_learn_patterns
+      reset_triggers
+      @changed = false
     end
-    @changed = false
   end
 
   def read_factfile(name=@filename,dir=@dir)
@@ -154,15 +186,8 @@ class FactoidsPlugin < Plugin
 
   def save
     return unless @changed
-    Dir.mkdir(@dir) unless FileTest.directory?(@dir)
-    fname = File.join(@dir,@filename)
-    ar = ["when | who | where | fact"]
-    @factoids.each { |f|
-      ar << "%s | %s | %s | %s" % [ f[:when], f[:who], f[:where], f[:fact]]
-    }
-    Utils.safe_save(fname) do |file|
-      file.puts ar
-    end
+    @registry[:factoids] = @factoids
+    @registry.flush
     @changed = false
   end
 
@@ -180,6 +205,20 @@ class FactoidsPlugin < Plugin
     }
   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
@@ -215,11 +254,22 @@ class FactoidsPlugin < Plugin
       end
     }
     debug "Triggers done in #{Time.now - start_time}"
-    @triggers.replace(triggers)
+    @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)
@@ -233,13 +283,13 @@ class FactoidsPlugin < Plugin
       m.reply _("I already know that %{factoid} [#%{idx}]" % {
         :factoid => factoid,
         :idx => idx
-      })
+      }) unless params[:silent]
     else
       @factoids << factoid
       @changed = true
-      m.okay
-      fact(m, :index => @factoids.length.to_s)
-      parse_for_trigger(factoid)
+      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
 
@@ -268,6 +318,15 @@ class FactoidsPlugin < Plugin
     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}" % {
@@ -277,19 +336,35 @@ class FactoidsPlugin < Plugin
     })
   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)
     total = @factoids.length
-    if params[:words].empty?
+    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?
-        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
-        # TODO config
-        max_facts = 5
+        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}" % {
@@ -303,21 +378,37 @@ class FactoidsPlugin < Plugin
           end
         end
         known.each { |f|
-          reply << long_fact(f)
+          reply << short_fact(f)
         }
       end
-      m.reply reply.join(" -- ")
+      m.reply reply.join(". "), :split_at => /\[\d+\/\d+\] /, :purge_split => false
     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)
+    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
 
@@ -341,7 +432,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)
@@ -422,6 +513,7 @@ 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+$/ }