rbot 0.9.9 → 0.9.10

data/data/rbot/plugins/freshmeat.rb

@@ -58,16 +58,22 @@ class FreshmeatPlugin < Plugin
   def freshmeat(m, params)
     max = params[:limit].to_i
     max = 8 if max > 8
-    xml = @bot.httputil.get(URI.parse("http://images.feedstermedia.com/feedcache/ostg/freshmeat/fm-releases-global.xml"))
-    unless xml
-      m.reply "freshmeat news parse failed"
-      return
-    end
-    doc = Document.new xml
-    unless doc
+    begin
+      xml = @bot.httputil.get(URI.parse("http://images.feedstermedia.com/feedcache/ostg/freshmeat/fm-releases-global.xml"))
+      unless xml
+        m.reply "freshmeat news parse failed"
+        return
+      end
+      doc = Document.new xml
+      unless doc
+        m.reply "freshmeat news parse failed"
+        return
+      end
+    rescue
       m.reply "freshmeat news parse failed"
       return
     end
+
     matches = Array.new
     max_width = 60
     title_width = 0

data/data/rbot/plugins/google.rb

@@ -49,3 +49,5 @@ class GooglePlugin < Plugin
 end
 plugin = GooglePlugin.new
 plugin.register("search")
+plugin.register("google")
+

data/data/rbot/plugins/grouphug.rb

@@ -0,0 +1,36 @@
+# Plugin for the Ruby IRC bot (http://linuxbrit.co.uk/rbot/)
+# (c) 2005 Mark Kretschmann <markey@web.de>
+# Licensed under GPL V2.
+
+require "net/http"
+
+
+class GrouphugPlugin < Plugin
+    def help( plugin, topic="" )
+        "Grouphug plugin. Confess! Usage: 'confess' for random confession, 'confess <number>' for specific one."
+    end
+
+    def privmsg( m )
+        path = "/random"
+        path = "/confessions/#{m.params()}" if m.params()
+        begin
+          data = bot.httputil.get(URI.parse("http://grouphug.us/#{path}"))
+
+          reg = Regexp.new( '(<td class="conf-text")(.*?)(<p>)(.*?)(</p>)', Regexp::MULTILINE )
+          confession = reg.match( data )[4]
+          confession.gsub!( /<.*?>/, "" ) # Remove html tags
+          confession.gsub!( "\t", "" ) # Remove tab characters
+
+          @bot.say(m.replyto, confession)
+        rescue
+          m.reply "failed to connect to grouphug.us"
+        end
+   end
+end
+
+
+plugin = GrouphugPlugin.new
+
+plugin.register("grouphug")
+plugin.register("confess")
+

data/data/rbot/plugins/imdb.rb

@@ -0,0 +1,92 @@
+# IMDB plugin for RubyBot
+# (c) 2005 Arnaud Cornet <arnaud.cornet@gmail.com>
+# Licensed under MIT License.
+
+require 'net/http'
+require 'cgi'
+require 'uri/common'
+
+class Imdb
+  def initialize(bot)
+    @bot = bot
+  end
+
+  def search(rawstr)
+    str = URI.escape(rawstr)
+    @http = @bot.httputil.get_proxy(URI.parse("http://us.imdb.com/find?q=#{str}"))
+    @http.start
+    begin
+    resp, data = @http.get("/find?q=#{str}", "User-Agent" => "Mozilla/5.0")
+    rescue Net::ProtoRetriableError => detail
+      head = detail.data
+      if head.code == "301" or head.code == "302"
+            return head['location'].gsub(/http:\/\/us.imdb.com/, "").gsub(/\?.*/, "")
+        end
+    end
+    if resp.code == "200"
+      m = /<a href="(\/title\/tt[0-9]+\/?)[^"]*"(:?[^>]*)>([^<]*)<\/a>/.match(resp.body)
+      if m
+        url = m[1]
+        title = m[2]
+        return url
+      end
+    elsif resp.code == "302"
+      return resp['location'].gsub(/http:\/\/us.imdb.com/, "").gsub(/\?.*/, "")
+    end
+    return nil
+  end
+
+  def info(rawstr)
+    sr = search(rawstr)
+    if !sr
+      debug "IMDB: search returned NIL"
+      return nil
+    end
+    resp, data = @http.get(sr, "User-Agent" =>
+      "Mozilla/5.0 (compatible; Konqueror/3.1; Linux)")
+    if resp.code == "200"
+      m = /<title>([^<]*)<\/title>/.match(resp.body)
+      return nil if !m
+      title = CGI.unescapeHTML(m[1])
+
+      m = /<b>([0-9.]+)\/10<\/b> \(([0-9,]+) votes?\)/.match(resp.body)
+      return nil if !m
+      score = m[1]
+      votes = m[2]
+
+      genre = Array.new
+      resp.body.scan(/<a href="\/Sections\/Genres\/[^\/]+\/">([^<]+)<\/a>/) do |gnr|
+        genre << gnr
+      end
+      return ["http://us.imdb.com" + sr, title, score, votes,
+        genre]
+    end
+    return nil
+  end
+end
+
+class ImdbPlugin < Plugin
+  def help(plugin, topic="")
+    "imdb <string> => search http://www.imdb.org for <string>"
+  end
+
+  def privmsg(m)
+    unless(m.params && m.params.length > 0)
+      m.reply "incorrect usage: " + help(m.plugin)
+      return
+    end
+
+    i = Imdb.new(@bot)
+    info = i.info(m.params)
+    if !info
+      m.reply "Nothing found for #{m.params}"
+      return nil
+    end
+    m.reply "#{info[1]} : #{info[0]}"
+    m.reply "Ratings: #{info[2]}/10 (#{info[3]} voters). Genre: #{info[4].join('/')}"
+  end
+end
+
+plugin = ImdbPlugin.new
+plugin.register("imdb")
+

data/data/rbot/plugins/insult.rb

@@ -216,6 +216,9 @@ class InsultPlugin < Plugin
       return "insult module topics: msginsult, insult"
     end
   end
+  def name
+    "insult"
+  end
   def privmsg(m)
     suffix=""
     unless(m.params)
@@ -233,7 +236,11 @@ class InsultPlugin < Plugin
     elsif(m.params =~ /^me$/)
       prefix = "you are "
     else
-      prefix = "#{m.params} is "
+      who = m.params
+      if (who == @bot.nick)
+        who = m.sourcenick
+      end
+      prefix = "#{who} is "
     end
     insult = generate_insult
     @bot.say msgto, prefix + insult + suffix

data/data/rbot/plugins/iplookup.rb

@@ -0,0 +1,227 @@
+#################################################################
+# IP Lookup Plugin
+# ----------------------------
+# by Chris Gahan (chris@ill-logic.com)
+#
+# Purpose:
+# ------------------
+# Lets you lookup the owner and their address for any IP address
+# or IRC user.
+#
+#################################################################
+
+require 'socket'
+require 'resolv'
+
+#################################################################
+## ARIN Whois module...
+##
+
+module ArinWhois
+
+  class Chunk < Hash
+    def customer?
+      keys.grep(/^(City|Address|StateProv|(Org|Cust)Name)$/).any?
+    end
+    
+    def network?
+      keys.grep(/^(CIDR|NetHandle|Parent)$/).any?
+    end
+
+    def contact?
+      keys.grep(/^(R|Org)(Tech|Abuse)(Handle|Name|Phone|Email)$/).any?
+    end
+    
+    def valid?
+      customer? or network? or contact?
+    end
+    
+    def owner
+      self[keys.grep(/^(Org|Cust)Name$/).first]
+    end
+    
+    def location
+      [ self['City'], self['StateProv'], self['Country'] ].compact.join(', ')
+    end
+    
+    def address
+      [ self['Address'], location, self['PostalCode'] ].compact.join(', ')
+    end
+    
+  end
+
+  class ArinWhoisParser
+    
+    def initialize(data)
+      @data = data
+    end
+    
+    def split_array_at(a, &block)
+      return a unless a.any?
+      a = a.to_a
+      
+      results = []
+      last_cutpoint = 0
+      
+      a.each_with_index do |el,i|
+        if block.call(el)
+          unless i == 0
+            results << a[last_cutpoint...i]
+            last_cutpoint = i
+          end
+        end
+      end
+      
+      if last_cutpoint < a.size or last_cutpoint == 0
+        results << a[last_cutpoint..-1]
+      end
+      
+      results
+    end
+    
+    # Whois output format
+    # ------------------------
+    # Owner info block:
+    #   {Org,Cust}Name
+    #   Address
+    #   City
+    #   StateProv
+    #   PostalCode
+    #   Country (2-digit)
+    #
+    # Network Information:
+    #   CIDR (69.195.25.0/25)
+    #   NetHandle (NET-72-14-192-0-1)
+    #   Parent (NET-72-0-0-0-0)
+    #
+    # Contacts:
+    #   ({R,Org}{Tech,Abuse}{Handle,Name,Phone,Email})*
+    
+    def parse_chunks
+      return if @data =~ /^No match found /
+      chunks = @data.gsub(/^# ARIN WHOIS database, last updated.+/m, '').scan(/(([^\n]+\n)+\n)/m)
+      chunks.map do |chunk|
+        result = Chunk.new
+        
+        chunk[0].scan(/([A-Za-z]+?):(.*)/).each do |tuple|
+          tuple[1].strip!
+          result[tuple[0]] = tuple[1].empty? ? nil : tuple[1]
+        end
+        
+        result
+      end
+    end
+    
+    
+    def get_parsed_data
+      return unless chunks = parse_chunks
+      
+      results = split_array_at(parse_chunks) {|chunk|chunk.customer?}
+      results.map do |chunks|
+        {
+          :customer => chunks.select{|x|x.customer?}[0],
+          :net      => chunks.select{|x|x.network?}[0],
+          :contacts => chunks.select{|x|x.contact?}
+        }
+      end
+    end
+    
+    # Return a hash with :customer, :net, and :contacts info filled in.
+    def get_most_specific_owner
+      return unless datas = get_parsed_data
+      
+      datas_with_bitmasks = datas.map do |data| 
+        bitmask = data[:net]['CIDR'].split('/')[1].to_i
+        [bitmask, data]
+      end
+      #datas_with_bitmasks.sort.each{|x|puts x[0]}
+      winner = datas_with_bitmasks.sort[-1][1]
+    end
+
+  end # of class ArinWhoisParser
+
+module_function
+
+  def raw_whois(query_string, host)
+    s = TCPsocket.open(host, 43)
+    s.write(query_string+"\n")
+    ret = s.read
+    s.close
+    return ret
+  end
+
+  def lookup(ip)
+    data = raw_whois("+#{ip}", 'whois.arin.net')
+    arin = ArinWhoisParser.new data
+    arin.get_most_specific_owner
+  end
+  
+  def lookup_location(ip)
+    result = lookup(ip)
+    result[:customer].location
+  end
+  
+  def lookup_address(ip)
+    result = lookup(ip)
+    result[:customer].address
+  end
+
+  def lookup_info(ip)
+    if result = lookup(ip)
+      "#{result[:net]['CIDR']} => #{result[:customer].owner} (#{result[:customer].address})"
+    else
+      "Address not found."
+    end
+  end
+
+end
+
+
+
+#################################################################
+## The Plugin
+##
+
+class IPLookupPlugin < Plugin
+  def help(plugin, topic="")
+    "iplookup [ip address / domain name] => lookup info about the owner of the IP address from the ARIN whois database"
+  end
+  
+  def iplookup(m, params)
+    reply = ""
+    if params[:domain]
+      begin
+        ip = Resolv.getaddress(params[:domain])
+        reply += "#{params[:domain]} | "
+      rescue => e
+        m.reply "#{e.message}"
+        return
+      end
+    else
+      ip = params[:ip]
+    end
+    
+    reply += ArinWhois.lookup_info(ip)
+    m.reply reply
+  end
+
+  def userip(m, params)
+    #users = @channels[m.channel].users
+    #m.reply "users = #{users.inspect}"
+    #m.reply @bot.sendq("WHO #{params[:user]}")
+  end
+  
+end
+
+plugin = IPLookupPlugin.new
+plugin.map 'iplookup :ip', :action => 'iplookup', :requirements => {:ip => /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/}
+plugin.map 'iplookup :domain', :action => 'iplookup', :requirements => {:domain => /^[a-z0-9\.\-]{4,255}$/i}
+plugin.map 'userip :user', :action => 'userip', :requirements => {:user => /\w+/}
+
+
+if __FILE__ == $0
+  include ArinWhois
+  data = open('whoistest.txt').read
+  c = ArinWhoisParser.new data
+  puts c.get_parsed_data.inspect
+end

data/data/rbot/plugins/karma.rb

@@ -15,7 +15,7 @@ class KarmaPlugin < Plugin
 
     # import if old file format found
     if(File.exist?("#{@bot.botclass}/karma.rbot"))
-      puts "importing old karma data"
+      log "importing old karma data"
       IO.foreach("#{@bot.botclass}/karma.rbot") do |line|
         if(line =~ /^(\S+)<=>([\d-]+)$/)
           item = $1
@@ -52,7 +52,7 @@ class KarmaPlugin < Plugin
   
   
   def help(plugin, topic="")
-    "karma module: <thing>++/<thing>-- => increase/decrease karma for <thing>, karma for <thing>? => show karma for <thing>, karmastats => show stats. Karma is a community rating system - only in-channel messages can affect karma and you cannot adjust your own."
+    "karma module: Listens to everyone's chat. <thing>++/<thing>-- => increase/decrease karma for <thing>, karma for <thing>? => show karma for <thing>, karmastats => show stats. Karma is a community rating system - only in-channel messages can affect karma and you cannot adjust your own."
   end
   def listen(m)
     return unless m.kind_of?(PrivMessage) && m.public?

data/data/rbot/plugins/keywords.rb

@@ -0,0 +1,470 @@
+require 'pp'
+
+# Keyword class
+#
+# Encapsulates a keyword ("foo is bar" is a keyword called foo, with type
+# is, and has a single value of bar).
+# Keywords can have multiple values, to_s() will choose one at random
+class Keyword
+
+  # type of keyword (e.g. "is" or "are")
+  attr_reader :type
+  
+  # type::   type of keyword (e.g "is" or "are")
+  # values:: array of values
+  # 
+  # create a keyword of type +type+ with values +values+
+  def initialize(type, values)
+    @type = type.downcase
+    @values = values
+  end
+
+  # pick a random value for this keyword and return it
+  def to_s
+    if(@values.length > 1)
+      Keyword.unescape(@values[rand(@values.length)])
+    else
+      Keyword.unescape(@values[0])
+    end
+  end
+
+  # describe the keyword (show all values without interpolation)
+  def desc
+    @values.join(" | ")
+  end
+
+  # return the keyword in a stringified form ready for storage
+  def dump
+    @type + "/" + Keyword.unescape(@values.join("<=or=>"))
+  end
+
+  # deserialize the stringified form to an object
+  def Keyword.restore(str)
+    if str =~ /^(\S+?)\/(.*)$/
+      type = $1
+      vals = $2.split("<=or=>")
+      return Keyword.new(type, vals)
+    end
+    return nil
+  end
+
+  # values:: array of values to add
+  # add values to a keyword
+  def <<(values)
+    if(@values.length > 1 || values.length > 1)
+      values.each {|v|
+        @values << v
+      }
+    else
+      @values[0] += " or " + values[0]
+    end
+  end
+
+  # unescape special words/characters in a keyword
+  def Keyword.unescape(str)
+    str.gsub(/\\\|/, "|").gsub(/ \\is /, " is ").gsub(/ \\are /, " are ").gsub(/\\\?(\s*)$/, "?\1")
+  end
+
+  # escape special words/characters in a keyword
+  def Keyword.escape(str)
+    str.gsub(/\|/, "\\|").gsub(/ is /, " \\is ").gsub(/ are /, " \\are ").gsub(/\?(\s*)$/, "\\?\1")
+  end
+end
+
+# keywords class. 
+#
+# Handles all that stuff like "bot: foo is bar", "bot: foo?"
+#
+# Fallback after core and auth have had a look at a message and refused to
+# handle it, checks for a keyword command or lookup, otherwise the message
+# is delegated to plugins
+class Keywords < Plugin
+  BotConfig.register BotConfigBooleanValue.new('keyword.listen',
+    :default => false,
+    :desc => "Should the bot listen to all chat and attempt to automatically detect keywords? (e.g. by spotting someone say 'foo is bar')")
+  BotConfig.register BotConfigBooleanValue.new('keyword.address',
+    :default => true,
+    :desc => "Should the bot require that keyword lookups are addressed to it? If not, the bot will attempt to lookup foo if someone says 'foo?' in channel")
+  
+  # create a new Keywords instance, associated to bot +bot+
+  def initialize
+    super
+
+    @statickeywords = Hash.new
+    @keywords = @registry.sub_registry('keywords') # DBTree.new bot, "keyword"
+    upgrade_data
+
+    scan
+    
+    # import old format keywords into DBHash
+    if(File.exist?("#{@bot.botclass}/keywords.rbot"))
+      log "auto importing old keywords.rbot"
+      IO.foreach("#{@bot.botclass}/keywords.rbot") do |line|
+        if(line =~ /^(.*?)\s*<=(is|are)?=?>\s*(.*)$/)
+          lhs = $1
+          mhs = $2
+          rhs = $3
+          mhs = "is" unless mhs
+          rhs = Keyword.escape rhs
+          values = rhs.split("<=or=>")
+          @keywords[lhs] = Keyword.new(mhs, values).dump
+        end
+      end
+      File.rename("#{@bot.botclass}/keywords.rbot", "#{@bot.botclass}/keywords.rbot.old")
+    end
+  end
+  
+  # drop static keywords and reload them from files, picking up any new
+  # keyword files that have been added
+  def rescan
+    @statickeywords = Hash.new
+    scan
+  end
+
+  # load static keywords from files, picking up any new keyword files that
+  # have been added
+  def scan
+    # first scan for old DBHash files, and convert them
+    Dir["#{@bot.botclass}/keywords/*"].each {|f|
+      next unless f =~ /\.db$/
+      log "upgrading keyword db #{f} (rbot 0.9.5 or prior) database format"
+      newname = f.gsub(/\.db$/, ".kdb")
+      old = BDB::Hash.open f, nil, 
+                           "r+", 0600
+      new = BDB::CIBtree.open(newname, nil, 
+                              BDB::CREATE | BDB::EXCL,
+                              0600)
+      old.each {|k,v|
+        new[k] = v
+      }
+      old.close
+      new.close
+      File.delete(f)
+    }
+    
+    # then scan for current DBTree files, and load them
+    Dir["#{@bot.botclass}/keywords/*"].each {|f|
+      next unless f =~ /\.kdb$/
+      hsh = DBTree.new @bot, f, true
+      key = File.basename(f).gsub(/\.kdb$/, "")
+      debug "keywords module: loading DBTree file #{f}, key #{key}"
+      @statickeywords[key] = hsh
+    }
+    
+    # then scan for non DB files, and convert/import them and delete
+    Dir["#{@bot.botclass}/keywords/*"].each {|f|
+      next if f =~ /\.kdb$/
+      next if f =~ /CVS$/
+      log "auto converting keywords from #{f}"
+      key = File.basename(f)
+      unless @statickeywords.has_key?(key)
+        @statickeywords[key] = DBHash.new @bot, "#{f}.db", true
+      end
+      IO.foreach(f) {|line|
+        if(line =~ /^(.*?)\s*<?=(is|are)?=?>\s*(.*)$/)
+          lhs = $1
+          mhs = $2
+          rhs = $3
+          # support infobot style factfiles, by fixing them up here
+          rhs.gsub!(/\$who/, "<who>")
+          mhs = "is" unless mhs
+          rhs = Keyword.escape rhs
+          values = rhs.split("<=or=>")
+          @statickeywords[key][lhs] = Keyword.new(mhs, values).dump
+        end
+      }
+      File.delete(f)
+      @statickeywords[key].flush
+    }
+  end
+
+  # upgrade data files found in old rbot formats to current
+  def upgrade_data
+    if File.exist?("#{@bot.botclass}/keywords.db")
+      log "upgrading old keywords (rbot 0.9.5 or prior) database format"
+      old = BDB::Hash.open "#{@bot.botclass}/keywords.db", nil, 
+                           "r+", 0600
+      old.each {|k,v|
+        @keywords[k] = v
+      }
+      old.close
+      @keywords.flush
+      File.rename("#{@bot.botclass}/keywords.db", "#{@bot.botclass}/keywords.db.old")
+    end
+  
+    if File.exist?("#{@bot.botclass}/keyword.db")
+      log "upgrading old keywords (rbot 0.9.9 or prior) database format"
+      old = BDB::CIBtree.open "#{@bot.botclass}/keyword.db", nil, 
+                           "r+", 0600
+      old.each {|k,v|
+        @keywords[k] = v
+      }
+      old.close
+      @keywords.flush
+      File.rename("#{@bot.botclass}/keyword.db", "#{@bot.botclass}/keyword.db.old")
+    end
+  end
+
+  # save dynamic keywords to file
+  def save
+    @keywords.flush
+  end
+  def oldsave
+    File.open("#{@bot.botclass}/keywords.rbot", "w") do |file|
+      @keywords.each do |key, value|
+        file.puts "#{key}<=#{value.type}=>#{value.dump}"
+      end
+    end
+  end
+  
+  # lookup keyword +key+, return it or nil
+  def [](key)
+    return nil if key.nil?
+    debug "keywords module: looking up key #{key}"
+    if(@keywords.has_key?(key))
+      return Keyword.restore(@keywords[key])
+    else
+      # key name order for the lookup through these
+      @statickeywords.keys.sort.each {|k|
+        v = @statickeywords[k]
+        if v.has_key?(key)
+          return Keyword.restore(v[key])
+        end
+      }
+    end
+    return nil
+  end
+
+  # does +key+ exist as a keyword?
+  def has_key?(key)
+    if @keywords.has_key?(key) && Keyword.restore(@keywords[key]) != nil
+      return true
+    end
+    @statickeywords.each {|k,v|
+      if v.has_key?(key) && Keyword.restore(v[key]) != nil
+        return true
+      end
+    }
+    return false
+  end
+
+  # m::     PrivMessage containing message info
+  # key::   key being queried
+  # dunno:: optional, if true, reply "dunno" if +key+ not found
+  # 
+  # handle a message asking about a keyword
+  def keyword(m, key, dunno=true)
+    return if key.nil?
+     unless(kw = self[key])
+       m.reply @bot.lang.get("dunno") if (dunno)
+       return
+     end
+     response = kw.to_s
+     response.gsub!(/<who>/, m.sourcenick)
+     if(response =~ /^<reply>\s*(.*)/)
+       m.reply "#$1"
+     elsif(response =~ /^<action>\s*(.*)/)
+       @bot.action m.replyto, "#$1"
+     elsif(m.public? && response =~ /^<topic>\s*(.*)/)
+       topic = $1
+       @bot.topic m.target, topic
+     else
+       m.reply "#{key} #{kw.type} #{response}"
+     end
+  end
+
+  
+  # handle a message which alters a keyword
+  # like "foo is bar", or "no, foo is baz", or "foo is also qux"
+  def keyword_command(sourcenick, target, lhs, mhs, rhs, quiet=false)
+    debug "got keyword command #{lhs}, #{mhs}, #{rhs}"
+    overwrite = false
+    overwrite = true if(lhs.gsub!(/^no,\s*/, ""))
+    also = true if(rhs.gsub!(/^also\s+/, ""))
+    values = rhs.split(/\s+\|\s+/)
+    lhs = Keyword.unescape lhs
+    if(overwrite || also || !has_key?(lhs))
+      if(also && has_key?(lhs))
+        kw = self[lhs]
+        kw << values
+        @keywords[lhs] = kw.dump
+      else
+        @keywords[lhs] = Keyword.new(mhs, values).dump
+      end
+      @bot.okay target if !quiet
+    elsif(has_key?(lhs))
+      kw = self[lhs]
+      @bot.say target, "but #{lhs} #{kw.type} #{kw.desc}" if kw && !quiet
+    end
+  end
+
+  # return help string for Keywords with option topic +topic+
+  def help(plugin, topic="")
+    case topic
+      when "overview"
+        return "set: <keyword> is <definition>, overide: no, <keyword> is <definition>, add to definition: <keyword> is also <definition>, random responses: <keyword> is <definition> | <definition> [| ...], plurals: <keyword> are <definition>, escaping: \\is, \\are, \\|, specials: <reply>, <action>, <who>"
+      when "set"
+        return "set => <keyword> is <definition>"
+      when "plurals"
+        return "plurals => <keywords> are <definition>"
+      when "override"
+        return "overide => no, <keyword> is <definition>"
+      when "also"
+        return "also => <keyword> is also <definition>"
+      when "random"
+        return "random responses => <keyword> is <definition> | <definition> [| ...]"
+      when "get"
+        return "asking for keywords => (with addressing) \"<keyword>?\", (without addressing) \"'<keyword>\""
+      when "tell"
+        return "tell <nick> about <keyword> => if <keyword> is known, tell <nick>, via /msg, its definition"
+      when "forget"
+        return "forget <keyword> => forget fact <keyword>"
+      when "keywords"
+        return "keywords => show current keyword counts"
+      when "<reply>"
+        return "<reply> => normal response is \"<keyword> is <definition>\", but if <definition> begins with <reply>, the response will be \"<definition>\""
+      when "<action>"
+        return "<action> => makes keyword respnse \"/me <definition>\""
+      when "<who>"
+        return "<who> => replaced with questioner in reply"
+      when "<topic>"
+        return "<topic> => respond by setting the topic to the rest of the definition"
+      when "search"
+        return "keywords search [--all] [--full] <regexp> => search keywords for <regexp>. If --all is set, search static keywords too, if --full is set, search definitions too."
+      else
+        return "Keyword module (Fact learning and regurgitation) topics: overview, set, plurals, override, also, random, get, tell, forget, keywords, keywords search, <reply>, <action>, <who>, <topic>"
+    end
+  end
+
+  # handle a message asking the bot to tell someone about a keyword
+  def keyword_tell(m, param)
+    target = param[:target]
+    key = nil
+
+    # extract the keyword from the message, because unfortunately
+    # the message mapper doesn't preserve whtiespace
+    if m.message =~ /about\s+(.+)$/
+      key = $1
+    end
+
+    unless(kw = self[key])
+      m.reply @bot.lang.get("dunno_about_X") % key
+      return
+    end
+    
+    response = kw.to_s
+    response.gsub!(/<who>/, m.sourcenick)
+    if(response =~ /^<reply>\s*(.*)/)
+      @bot.say target, "#{m.sourcenick} wanted me to tell you: (#{key}) #$1"
+      m.reply "okay, I told #{target}: (#{key}) #$1"
+    elsif(response =~ /^<action>\s*(.*)/)
+      @bot.action target, "#$1 (#{m.sourcenick} wanted me to tell you)"
+      m.reply "okay, I told #{target}: * #$1"
+    else
+      @bot.say target, "#{m.sourcenick} wanted me to tell you that #{key} #{kw.type} #{response}"
+      m.reply "okay, I told #{target} that #{key} #{kw.type} #{response}"
+    end
+  end
+
+  # return the number of known keywords
+  def keyword_stats(m, param)
+    length = 0
+    @statickeywords.each {|k,v|
+      length += v.length
+    }
+    m.reply "There are currently #{@keywords.length} keywords, #{length} static facts defined."
+  end
+
+  # search for keywords, optionally also the definition and the static keywords
+  def keyword_search(m, param)
+    str = param[:pattern]
+    all = (param[:all] == '--all')
+    full = (param[:full] == '--full')
+    
+    begin
+      re = Regexp.new(str, Regexp::IGNORECASE)
+      if(@bot.auth.allow?("keyword", m.source, m.replyto))
+        matches = Array.new
+        @keywords.each {|k,v|
+          kw = Keyword.restore(v)
+          if re.match(k) || (full && re.match(kw.desc))
+            matches << [k,kw]
+          end
+        }
+        if all
+          @statickeywords.each {|k,v|
+            v.each {|kk,vv|
+              kw = Keyword.restore(vv)
+              if re.match(kk) || (full && re.match(kw.desc))
+                matches << [kk,kw]
+              end
+            }
+          }
+        end
+        if matches.length == 1
+          rkw = matches[0]
+          m.reply "#{rkw[0]} #{rkw[1].type} #{rkw[1].desc}"
+        elsif matches.length > 0
+          i = 0
+          matches.each {|rkw|
+            m.reply "[#{i+1}/#{matches.length}] #{rkw[0]} #{rkw[1].type} #{rkw[1].desc}"
+            i += 1
+            break if i == 3
+          }
+        else
+          m.reply "no keywords match #{str}"
+        end
+      end
+    rescue RegexpError => e
+      m.reply "no keywords match #{str}: #{e}"
+    rescue
+      debug e.inspect
+      m.reply "no keywords match #{str}: an error occurred"
+    end
+  end
+
+  # forget one of the dynamic keywords
+  def keyword_forget(m, param)
+    key = param[:key]
+    if(@keywords.has_key?(key))
+      @keywords.delete(key)
+      @bot.okay m.replyto
+    end
+  end
+
+  # privmsg handler
+  def listen(m)
+    return if m.replied?
+    if(m.address?)
+      if(!(m.message =~ /\\\?\s*$/) && m.message =~ /^(.*\S)\s*\?\s*$/)
+        keyword m, $1 if(@bot.auth.allow?("keyword", m.source, m.replyto))
+      elsif(m.message =~ /^(.*?)\s+(is|are)\s+(.*)$/)
+        keyword_command(m.sourcenick, m.replyto, $1, $2, $3) if(@bot.auth.allow?("keycmd", m.source, m.replyto))
+      end
+    else
+      # in channel message, not to me
+      # TODO option to do if(m.message =~ /^(.*)$/, ie try any line as a
+      # keyword lookup.
+      if(m.message =~ /^'(.*)$/ || (!@bot.config["keyword.address"] && m.message =~ /^(.*\S)\s*\?\s*$/))
+        keyword m, $1, false if(@bot.auth.allow?("keyword", m.source))
+      elsif(@bot.config["keyword.listen"] == true && (m.message =~ /^(.*?)\s+(is|are)\s+(.*)$/))
+        # TODO MUCH more selective on what's allowed here
+        keyword_command(m.sourcenick, m.replyto, $1, $2, $3, true) if(@bot.auth.allow?("keycmd", m.source))
+      end
+    end
+  end
+end
+
+plugin = Keywords.new
+
+plugin.map 'keyword stats', :action => 'keyword_stats'
+
+plugin.map 'keyword search :all :full :pattern', :action => 'keyword_search',
+           :defaults => {:all => '', :full => ''},
+           :requirements => {:all => '--all', :full => '--full'}
+           
+plugin.map 'keyword forget :key', :action => 'keyword_forget'
+plugin.map 'forget :key', :action => 'keyword_forget', :auth => 'keycmd'
+
+plugin.map 'keyword tell :target about *keyword', :action => 'keyword_tell'
+plugin.map 'tell :target about *keyword', :action => 'keyword_tell', :auth => 'keyword'