]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/markov.rb
nickserv plugin: regexp tweaks and case insensitivity
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / markov.rb
index 6c51af5179f696a35d8cf749e31432042c236db2..9b83e53a56d0f6b85a1f4558431cb8045a32d331 100644 (file)
@@ -1,17 +1,78 @@
+#-- vim:sw=2:et
+#++
+#
+# :title: Markov plugin
+#
+# Author:: Tom Gilbert <tom@linuxbrit.co.uk>
+# Copyright:: (C) 2005 Tom Gilbert
+#
+# Contribute to chat with random phrases built from word sequences learned
+# by listening to chat
+
 class MarkovPlugin < Plugin
+  Config.register Config::BooleanValue.new('markov.enabled',
+    :default => false,
+    :desc => "Enable and disable the plugin")
+  Config.register Config::IntegerValue.new('markov.probability',
+    :default => 25,
+    :validate => Proc.new { |v| (0..100).include? v },
+    :desc => "Percentage chance of markov plugin chipping in")
+  Config.register Config::ArrayValue.new('markov.ignore',
+    :default => [],
+    :desc => "Hostmasks and channel names markov should NOT learn from (e.g. idiot*!*@*, #privchan).")
+  Config.register Config::IntegerValue.new('markov.max_words',
+    :default => 50,
+    :validate => Proc.new { |v| (0..100).include? v },
+    :desc => "Maximum number of words the bot should put in a sentence")
+
   def initialize
     super
     @registry.set_default([])
-    @lastline = false
+    if @registry.has_key?('enabled')
+      @bot.config['markov.enabled'] = @registry['enabled']
+      @registry.delete('enabled')
+    end
+    if @registry.has_key?('probability')
+      @bot.config['markov.probability'] = @registry['probability']
+      @registry.delete('probability')
+    end
+    if @bot.config['markov.ignore_users']
+      debug "moving markov.ignore_users to markov.ignore"
+      @bot.config['markov.ignore'] = @bot.config['markov.ignore_users'].dup
+      @bot.config.delete('markov.ignore_users'.to_sym)
+    end
+    @learning_queue = Queue.new
+    @learning_thread = Thread.new do
+      while s = @learning_queue.pop
+        learn s
+        sleep 0.5
+      end
+    end
+    @learning_thread.priority = -1
+  end
+
+  def cleanup
+    debug 'closing learning thread'
+    @learning_queue.push nil
+    @learning_thread.join
+    debug 'learning thread closed'
   end
 
-  def generate_string(seedline)
-    # limit to max of 50 words
-    return unless seedline
-    word1, word2 = seedline.split(/\s+/)
+  def generate_string(word1, word2)
+    # limit to max of markov.max_words words
     output = word1 + " " + word2
-    50.times do
-      wordlist = @registry["#{word1}/#{word2}"]
+
+    # try to avoid :nonword in the first iteration
+    wordlist = @registry["#{word1} #{word2}"]
+    wordlist.delete(:nonword)
+    if not wordlist.empty?
+      word3 = wordlist[rand(wordlist.length)]
+      output = output + " " + word3
+      word1, word2 = word2, word3
+    end
+
+    (@bot.config['markov.max_words'] - 1).times do
+      wordlist = @registry["#{word1} #{word2}"]
       break if wordlist.empty?
       word3 = wordlist[rand(wordlist.length)]
       break if word3 == :nonword
@@ -22,7 +83,7 @@ class MarkovPlugin < Plugin
   end
 
   def help(plugin, topic="")
-    "markov plugin: listens to chat to build a markov chain, with which it can (perhaps) attempt to (inanely) contribute to 'discussion'. Sort of.. Will get a *lot* better after listening to a lot of chat. usage: 'markov' to attempt to say something relevant to the last line of chat, if it can.  other options to markov: 'ignore' => ignore a hostmask (accept no input), 'status' => show current status, 'probability' => set the % chance of rbot responding to input, 'chat' => try and say something intelligent, 'chat about <foo> <bar>' => riff on a word pair (if possible)"
+    "markov plugin: listens to chat to build a markov chain, with which it can (perhaps) attempt to (inanely) contribute to 'discussion'. Sort of.. Will get a *lot* better after listening to a lot of chat. usage: 'markov' to attempt to say something relevant to the last line of chat, if it can.  other options to markov: 'ignore' => ignore a hostmask (accept no input), 'status' => show current status, 'probability [<chance>]' => set the % chance of rbot responding to input, or display the current probability, 'chat' => try and say something intelligent, 'chat about <foo> <bar>' => riff on a word pair (if possible)"
   end
 
   def clean_str(s)
@@ -33,93 +94,106 @@ class MarkovPlugin < Plugin
   end
 
   def probability?
-    prob = @registry['probability']
-    prob = 25 if prob.kind_of? Array;
-    prob = 0 if prob < 0
-    prob = 100 if prob > 100
-    return prob
+    return @bot.config['markov.probability']
   end
 
   def status(m,params)
-    enabled = @registry['enabled']
-    if (enabled)
+    if @bot.config['markov.enabled']
       m.reply "markov is currently enabled, #{probability?}% chance of chipping in"
     else
       m.reply "markov is currently disabled"
     end
   end
 
-  def ignore?(user=nil)
-    return @registry['ignore_users'].include?(user)
+  def ignore?(m=nil)
+    return false unless m
+    return true if m.address? or m.private?
+    @bot.config['markov.ignore'].each do |mask|
+      return true if m.channel.downcase == mask.downcase
+      return true if m.source.matches?(mask)
+    end
+    return false
   end
 
   def ignore(m, params)
-    if @registry['ignore_users'].nil?
-      @registry['ignore_users'] = []
-    end
     action = params[:action]
     user = params[:option]
     case action
     when 'remove':
-      if @registry['ignore_users'].include? user
-        s = @registry['ignore_users']
+      if @bot.config['markov.ignore'].include? user
+        s = @bot.config['markov.ignore']
         s.delete user
-        @registry['ignore_users'] = s
+        @bot.config['ignore'] = s
         m.reply "#{user} removed"
       else
         m.reply "not found in list"
       end
     when 'add':
       if user
-        if @registry['ignore_users'].include?(user)
+        if @bot.config['markov.ignore'].include?(user)
           m.reply "#{user} already in list"
         else
-          @registry['ignore_users'] = @registry['ignore_users'].push user 
+          @bot.config['markov.ignore'] = @bot.config['markov.ignore'].push user
           m.reply "#{user} added to markov ignore list"
         end
       else
-        m.reply "give the name of a person to ignore"
+        m.reply "give the name of a person or channel to ignore"
       end
     when 'list':
-      m.reply "I'm ignoring #{@registry['ignore_users'].join(", ")}"
+      m.reply "I'm ignoring #{@bot.config['markov.ignore'].join(", ")}"
     else
-      m.reply "have markov ignore the input from a hostmask.  usage: markov ignore add <mask>; markov ignore remove <mask>; markov ignore list"
+      m.reply "have markov ignore the input from a hostmask or a channel.  usage: markov ignore add <mask or channel>; markov ignore remove <mask or channel>; markov ignore list"
     end
   end
 
   def enable(m, params)
-    @registry['enabled'] = true
+    @bot.config['markov.enabled'] = true
     m.okay
   end
 
   def probability(m, params)
-    @registry['probability'] = params[:probability].to_i
-    m.okay
+    if params[:probability]
+      @bot.config['markov.probability'] = params[:probability].to_i
+      m.okay
+    else
+      m.reply _("markov has a %{prob}% chance of chipping in") % { :prob => probability? }
+    end
   end
 
   def disable(m, params)
-    @registry['enabled'] = false
+    @bot.config['markov.enabled'] = false
     m.okay
   end
 
   def should_talk
-    return false unless @registry['enabled']
+    return false unless @bot.config['markov.enabled']
     prob = probability?
     return true if prob > rand(100)
     return false
   end
 
+  def delay
+    1 + rand(5)
+  end
+
   def random_markov(m, message)
     return unless should_talk
-    line = generate_string(message)
+
+    word1, word2 = message.split(/\s+/)
+    return unless word1 and word2
+    line = generate_string(word1, word2)
     return unless line
-    m.reply line unless line == message
+    # we do nothing if the line we return is just an initial substring
+    # of the line we received
+    return if message.index(line) == 0
+    @bot.timer.add_once(delay) {
+      m.reply line
+    }
   end
 
   def chat(m, params)
-    seed = "#{params[:seed1]} #{params[:seed2]}"
-    line = generate_string seed
-    if line != seed
+    line = generate_string(params[:seed1], params[:seed2])
+    if line != "#{params[:seed1]} #{params[:seed2]}"
       m.reply line 
     else
       m.reply "I can't :("
@@ -131,7 +205,7 @@ class MarkovPlugin < Plugin
     word1, word2 = :nonword, :nonword
     output = Array.new
     50.times do
-      wordlist = @registry["#{word1}/#{word2}"]
+      wordlist = @registry["#{word1} #{word2}"]
       break if wordlist.empty?
       word3 = wordlist[rand(wordlist.length)]
       break if word3 == :nonword
@@ -145,27 +219,35 @@ class MarkovPlugin < Plugin
     end
   end
   
-  def listen(m)
-    return unless m.kind_of?(PrivMessage) && m.public?
-    return if m.address?
-    return if ignore? m.source
+  def message(m)
+    return if ignore? m
 
     # in channel message, the kind we are interested in
-    message = clean_str m.message
+    message = clean_str m.plainmessage
+
+    if m.action?
+      message = "#{m.sourcenick} #{message}"
+    end
     
+    @learning_queue.push message
+    random_markov(m, message) unless m.replied?
+  end
+
+  def learn(message)
+    # debug "learning #{message}"
     wordlist = message.split(/\s+/)
-    return unless wordlist.length > 2
-    @lastline = message
+    return unless wordlist.length >= 2
     word1, word2 = :nonword, :nonword
     wordlist.each do |word3|
-      @registry["#{word1}/#{word2}"] = @registry["#{word1}/#{word2}"].push(word3)
+      k = "#{word1} #{word2}"
+      @registry[k] = @registry[k].push(word3)
       word1, word2 = word2, word3
     end
-    @registry["#{word1}/#{word2}"] = [:nonword]
-
-    random_markov(m, message)
+    k = "#{word1} #{word2}"
+    @registry[k] = @registry[k].push(:nonword)
   end
 end
+
 plugin = MarkovPlugin.new
 plugin.map 'markov ignore :action :option', :action => "ignore"
 plugin.map 'markov ignore :action', :action => "ignore"
@@ -175,5 +257,5 @@ plugin.map 'markov disable', :action => "disable"
 plugin.map 'markov status', :action => "status"
 plugin.map 'chat about :seed1 :seed2', :action => "chat"
 plugin.map 'chat', :action => "rand_chat"
-plugin.map 'markov probability :probability', :action => "probability",
-           :requirements => {:probability => /^\d+$/}
+plugin.map 'markov probability [:probability]', :action => "probability",
+           :requirements => {:probability => /^\d+%?$/}