]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/markov.rb
markov: organize help
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / markov.rb
old mode 100644 (file)
new mode 100755 (executable)
index 5bae9bb..deeb9ca
@@ -17,9 +17,13 @@ class MarkovPlugin < Plugin
     :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_users',
+  Config.register Config::ArrayValue.new('markov.ignore',
     :default => [],
-    :desc => "Hostmasks of users to be ignored")
+    :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
@@ -32,34 +36,109 @@ class MarkovPlugin < Plugin
       @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_line 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(word1, word2)
-    # limit to max of 50 words
-    output = word1 + " " + word2
+    # limit to max of markov.max_words words
+    if word2
+      output = "#{word1} #{word2}"
+    else
+      output = word1.to_s
+    end
 
-    # 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
+    if @registry.key? output
+      wordlist = @registry[output]
+      wordlist.delete(:nonword)
+    else
+      output.downcase!
+      keys = []
+      @registry.each_key(output) do |key|
+        if key.downcase.include? output
+          keys << key
+        else
+          break
+        end
+      end
+      if keys.empty?
+        keys = @registry.keys.select { |k| k.downcase.include? output }
+      end
+      return nil if keys.empty?
+      while key = keys.delete_one
+        wordlist = @registry[key]
+        wordlist.delete(:nonword)
+        unless wordlist.empty?
+          output = key
+          word1, word2 = output.split
+          break
+        end
+      end
     end
+    return nil if wordlist.empty?
 
-    49.times do
+    word3 = wordlist.pick_one
+    output << " #{word3}"
+    word1, word2 = word2, word3
+
+    (@bot.config['markov.max_words'] - 1).times do
       wordlist = @registry["#{word1} #{word2}"]
       break if wordlist.empty?
-      word3 = wordlist[rand(wordlist.length)]
+      word3 = wordlist.pick_one
       break if word3 == :nonword
-      output = output + " " + word3
+      output << " #{word3}"
       word1, word2 = word2, word3
     end
     return output
   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 [<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)"
+    topic, subtopic = topic.split
+
+    case topic
+    when "ignore"
+      case subtopic
+      when "add"
+        "markov ignore add <hostmask|channel> => ignore a hostmask or a channel"
+      when "list"
+        "markov ignore list => show ignored hostmasks and channels"
+      when "remove"
+        "markov ignore remove <hostmask|channel> => unignore a hostmask or channel"
+      else
+        "ignore hostmasks or channels -- topics: add, remove, list"
+      end
+    when "status"
+      "markov status => show if markov is enabled, probability and amount of messages in queue for learning"
+    when "probability"
+      "markov probability [<percent>] => set the % chance of rbot responding to input, or display the current probability"
+    when "chat"
+      case subtopic
+      when "about"
+        "markov chat about <word> [<another word>] => talk about <word> or riff on a word pair (if possible)"
+      else
+        "markov chat => try to say something intelligent"
+      end
+    else
+      "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: 'chat' to attempt to say something relevant to the last line of chat, if it can -- help topics: ignore, status, probability, chat, chat about"
+    end
   end
 
   def clean_str(s)
@@ -75,16 +154,21 @@ class MarkovPlugin < Plugin
 
   def status(m,params)
     if @bot.config['markov.enabled']
-      m.reply "markov is currently enabled, #{probability?}% chance of chipping in"
+      reply = _("markov is currently enabled, %{p}% chance of chipping in") % { :p => probability? }
+      l = @learning_queue.length
+      reply << (_(", %{l} messages in queue") % {:l => l}) if l > 0
     else
-      m.reply "markov is currently disabled"
+      reply = _("markov is currently disabled")
     end
+    m.reply reply
   end
 
-  def ignore?(user=nil)
-    return false unless user
-    @bot.config['markov.ignore_users'].each do |mask|
-      return true if user.matches?(mask)
+  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
@@ -94,29 +178,29 @@ class MarkovPlugin < Plugin
     user = params[:option]
     case action
     when 'remove':
-      if @bot.config['markov.ignore_users'].include? user
-        s = @bot.config['markov.ignore_users']
+      if @bot.config['markov.ignore'].include? user
+        s = @bot.config['markov.ignore']
         s.delete user
-        @bot.config['ignore_users'] = s
-        m.reply "#{user} removed"
+        @bot.config['ignore'] = s
+        m.reply _("%{u} removed") % { :u => user }
       else
-        m.reply "not found in list"
+        m.reply _("not found in list")
       end
     when 'add':
       if user
-        if @bot.config['markov.ignore_users'].include?(user)
-          m.reply "#{user} already in list"
+        if @bot.config['markov.ignore'].include?(user)
+          m.reply _("%{u} already in list") % { :u => user }
         else
-          @bot.config['markov.ignore_users'] = @bot.config['markov.ignore_users'].push user
-          m.reply "#{user} added to markov ignore list"
+          @bot.config['markov.ignore'] = @bot.config['markov.ignore'].push user
+          m.reply _("%{u} added to markov ignore list") % { :u => user }
         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 #{@bot.config['markov.ignore_users'].join(", ")}"
+      m.reply _("I'm ignoring %{ignored}") % { :ignored => @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
 
@@ -154,20 +238,23 @@ class MarkovPlugin < Plugin
     return unless should_talk
 
     word1, word2 = message.split(/\s+/)
+    return unless word1 and word2
     line = generate_string(word1, word2)
     return unless line
-    return if 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
+      m.reply line, :nick => false, :to => :public
     }
   end
 
   def chat(m, params)
     line = generate_string(params[:seed1], params[:seed2])
-    if line != "#{params[:seed1]} #{params[:seed2]}"
-      m.reply line 
+    if line and line != [params[:seed1], params[:seed2]].compact.join(" ")
+      m.reply line
     else
-      m.reply "I can't :("
+      m.reply _("I can't :(")
     end
   end
 
@@ -186,33 +273,105 @@ class MarkovPlugin < Plugin
     if output.length > 1
       m.reply output.join(" ")
     else
-      m.reply "I can't :("
+      m.reply _("I can't :(")
     end
   end
-  
-  def listen(m)
-    return unless m.kind_of?(PrivMessage) && m.public?
-    return if m.address?
-    return if ignore? m.source
+
+  def learn(*lines)
+    lines.each { |l| @learning_queue.push l }
+  end
+
+  def unreplied(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
-    
+
+    learn message
+    random_markov(m, message) unless m.replied?
+  end
+
+  def learn_line(message)
+    # debug "learning #{message}"
     wordlist = message.split(/\s+/)
     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}"] = @registry["#{word1} #{word2}"].push(:nonword)
+    k = "#{word1} #{word2}"
+    @registry[k] = @registry[k].push(:nonword)
+  end
+
+  # TODO allow learning from URLs
+  def learn_from(m, params)
+    begin
+      path = params[:file]
+      file = File.open(path, "r")
+      pattern = params[:pattern].empty? ? nil : Regexp.new(params[:pattern].to_s)
+    rescue Errno::ENOENT
+      m.reply _("no such file")
+      return
+    end
+
+    if file.eof?
+      m.reply _("the file is empty!")
+      return
+    end
+
+    if params[:testing]
+      lines = []
+      range = case params[:lines]
+      when /^\d+\.\.\d+$/
+        Range.new(*params[:lines].split("..").map { |e| e.to_i })
+      when /^\d+$/
+        Range.new(1, params[:lines].to_i)
+      else
+        Range.new(1, [@bot.config['send.max_lines'], 3].max)
+      end
+
+      file.each do |line|
+        next unless file.lineno >= range.begin
+        lines << line.chomp
+        break if file.lineno == range.end
+      end
 
-    return if m.replied?
-    random_markov(m, message)
+      lines = lines.map do |l|
+        pattern ? l.scan(pattern).to_s : l
+      end.reject { |e| e.empty? }
+
+      if pattern
+        unless lines.empty?
+          m.reply _("example matches for that pattern at lines %{range} include: %{lines}") % {
+            :lines => lines.map { |e| Underline+e+Underline }.join(", "),
+            :range => range.to_s
+          }
+        else
+          m.reply _("the pattern doesn't match anything at lines %{range}") % {
+            :range => range.to_s
+          }
+        end
+      else
+        m.reply _("learning from the file without a pattern would learn, for example: ")
+        lines.each { |l| m.reply l }
+      end
+
+      return
+    end
+
+    if pattern
+      file.each { |l| learn(l.scan(pattern).to_s) }
+    else
+      file.each { |l| learn(l.chomp) }
+    end
+
+    m.okay
   end
 end
 
@@ -223,7 +382,16 @@ plugin.map 'markov ignore', :action => "ignore"
 plugin.map 'markov enable', :action => "enable"
 plugin.map 'markov disable', :action => "disable"
 plugin.map 'markov status', :action => "status"
-plugin.map 'chat about :seed1 :seed2', :action => "chat"
+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 learn from :file [:testing [:lines lines]] [using pattern *pattern]', :action => "learn_from", :thread => true,
+           :requirements => {
+             :testing => /^testing$/,
+             :lines   => /^(?:\d+\.\.\d+|\d+)$/ }
+
+plugin.default_auth('ignore', false)
+plugin.default_auth('probability', false)
+plugin.default_auth('learn', false)
+