lib/rbot/keywords.rb

   1 require 'pp'
   2
   3 module Irc
   4
   5   # Keyword class
   6   #
   7   # Encapsulates a keyword ("foo is bar" is a keyword called foo, with type
   8   # is, and has a single value of bar).
   9   # Keywords can have multiple values, to_s() will choose one at random
  10   class Keyword
  11
  12     # type of keyword (e.g. "is" or "are")
  13     attr_reader :type
  14
  15     # type::   type of keyword (e.g "is" or "are")
  16     # values:: array of values
  17     #
  18     # create a keyword of type +type+ with values +values+
  19     def initialize(type, values)
  20       @type = type.downcase
  21       @values = values
  22     end
  23
  24     # pick a random value for this keyword and return it
  25     def to_s
  26       if(@values.length > 1)
  27         Keyword.unescape(@values[rand(@values.length)])
  28       else
  29         Keyword.unescape(@values[0])
  30       end
  31     end
  32
  33     # describe the keyword (show all values without interpolation)
  34     def desc
  35       @values.join(" | ")
  36     end
  37
  38     # return the keyword in a stringified form ready for storage
  39     def dump
  40       @type + "/" + Keyword.unescape(@values.join("<=or=>"))
  41     end
  42
  43     # deserialize the stringified form to an object
  44     def Keyword.restore(str)
  45       if str =~ /^(\S+?)\/(.*)$/
  46         type = $1
  47         vals = $2.split("<=or=>")
  48         return Keyword.new(type, vals)
  49       end
  50       return nil
  51     end
  52
  53     # values:: array of values to add
  54     # add values to a keyword
  55     def <<(values)
  56       if(@values.length > 1 || values.length > 1)
  57         values.each {|v|
  58           @values << v
  59         }
  60       else
  61         @values[0] += " or " + values[0]
  62       end
  63     end
  64
  65     # unescape special words/characters in a keyword
  66     def Keyword.unescape(str)
  67       str.gsub(/\\\|/, "|").gsub(/ \\is /, " is ").gsub(/ \\are /, " are ").gsub(/\\\?(\s*)$/, "?\1")
  68     end
  69
  70     # escape special words/characters in a keyword
  71     def Keyword.escape(str)
  72       str.gsub(/\|/, "\\|").gsub(/ is /, " \\is ").gsub(/ are /, " \\are ").gsub(/\?(\s*)$/, "\\?\1")
  73     end
  74   end
  75
  76   # keywords class.
  77   #
  78   # Handles all that stuff like "bot: foo is bar", "bot: foo?"
  79   #
  80   # Fallback after core and auth have had a look at a message and refused to
  81   # handle it, checks for a keyword command or lookup, otherwise the message
  82   # is delegated to plugins
  83   class Keywords
  84     BotConfig.register BotConfigBooleanValue.new('keyword.listen',
  85       :default => false,
  86       :desc => "Should the bot listen to all chat and attempt to automatically detect keywords? (e.g. by spotting someone say 'foo is bar')")
  87     BotConfig.register BotConfigBooleanValue.new('keyword.address',
  88       :default => true,
  89       :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")
  90
  91     # create a new Keywords instance, associated to bot +bot+
  92     def initialize(bot)
  93       @bot = bot
  94       @statickeywords = Hash.new
  95       upgrade_data
  96       @keywords = DBTree.new bot, "keyword"
  97
  98       scan
  99
 100       # import old format keywords into DBHash
 101       if(File.exist?("#{@bot.botclass}/keywords.rbot"))
 102         puts "auto importing old keywords.rbot"
 103         IO.foreach("#{@bot.botclass}/keywords.rbot") do |line|
 104           if(line =~ /^(.*?)\s*<=(is|are)?=?>\s*(.*)$/)
 105             lhs = $1
 106             mhs = $2
 107             rhs = $3
 108             mhs = "is" unless mhs
 109             rhs = Keyword.escape rhs
 110             values = rhs.split("<=or=>")
 111             @keywords[lhs] = Keyword.new(mhs, values).dump
 112           end
 113         end
 114         File.delete("#{@bot.botclass}/keywords.rbot")
 115       end
 116     end
 117
 118     # drop static keywords and reload them from files, picking up any new
 119     # keyword files that have been added
 120     def rescan
 121       @statickeywords = Hash.new
 122       scan
 123     end
 124
 125     # load static keywords from files, picking up any new keyword files that
 126     # have been added
 127     def scan
 128       # first scan for old DBHash files, and convert them
 129       Dir["#{@bot.botclass}/keywords/*"].each {|f|
 130         next unless f =~ /\.db$/
 131         puts "upgrading keyword db #{f} (rbot 0.9.5 or prior) database format"
 132         newname = f.gsub(/\.db$/, ".kdb")
 133         old = BDB::Hash.open f, nil,
 134                              "r+", 0600, "set_pagesize" => 1024,
 135                              "set_cachesize" => [0, 32 * 1024, 0]
 136         new = BDB::CIBtree.open newname, nil,
 137                                 BDB::CREATE | BDB::EXCL | BDB::TRUNCATE,
 138                                 0600, "set_pagesize" => 1024,
 139                                 "set_cachesize" => [0, 32 * 1024, 0]
 140         old.each {|k,v|
 141           new[k] = v
 142         }
 143         old.close
 144         new.close
 145         File.delete(f)
 146       }
 147
 148       # then scan for current DBTree files, and load them
 149       Dir["#{@bot.botclass}/keywords/*"].each {|f|
 150         next unless f =~ /\.kdb$/
 151         hsh = DBTree.new @bot, f, true
 152         key = File.basename(f).gsub(/\.kdb$/, "")
 153         debug "keywords module: loading DBTree file #{f}, key #{key}"
 154         @statickeywords[key] = hsh
 155       }
 156
 157       # then scan for non DB files, and convert/import them and delete
 158       Dir["#{@bot.botclass}/keywords/*"].each {|f|
 159         next if f =~ /\.kdb$/
 160         next if f =~ /CVS$/
 161         puts "auto converting keywords from #{f}"
 162         key = File.basename(f)
 163         unless @statickeywords.has_key?(key)
 164           @statickeywords[key] = DBHash.new @bot, "#{f}.db", true
 165         end
 166         IO.foreach(f) {|line|
 167           if(line =~ /^(.*?)\s*<?=(is|are)?=?>\s*(.*)$/)
 168             lhs = $1
 169             mhs = $2
 170             rhs = $3
 171             # support infobot style factfiles, by fixing them up here
 172             rhs.gsub!(/\$who/, "<who>")
 173             mhs = "is" unless mhs
 174             rhs = Keyword.escape rhs
 175             values = rhs.split("<=or=>")
 176             @statickeywords[key][lhs] = Keyword.new(mhs, values).dump
 177           end
 178         }
 179         File.delete(f)
 180         @statickeywords[key].flush
 181       }
 182     end
 183
 184     # upgrade data files found in old rbot formats to current
 185     def upgrade_data
 186       if File.exist?("#{@bot.botclass}/keywords.db")
 187         puts "upgrading old keywords (rbot 0.9.5 or prior) database format"
 188         old = BDB::Hash.open "#{@bot.botclass}/keywords.db", nil,
 189                              "r+", 0600, "set_pagesize" => 1024,
 190                              "set_cachesize" => [0, 32 * 1024, 0]
 191         new = BDB::CIBtree.open "#{@bot.botclass}/keyword.db", nil,
 192                                 BDB::CREATE | BDB::EXCL | BDB::TRUNCATE,
 193                                 0600, "set_pagesize" => 1024,
 194                                 "set_cachesize" => [0, 32 * 1024, 0]
 195         old.each {|k,v|
 196           new[k] = v
 197         }
 198         old.close
 199         new.close
 200         File.delete("#{@bot.botclass}/keywords.db")
 201       end
 202     end
 203
 204     # save dynamic keywords to file
 205     def save
 206       @keywords.flush
 207     end
 208     def oldsave
 209       File.open("#{@bot.botclass}/keywords.rbot", "w") do |file|
 210         @keywords.each do |key, value|
 211           file.puts "#{key}<=#{value.type}=>#{value.dump}"
 212         end
 213       end
 214     end
 215
 216     # lookup keyword +key+, return it or nil
 217     def [](key)
 218       return nil if key.nil?
 219       debug "keywords module: looking up key #{key}"
 220       if(@keywords.has_key?(key))
 221         return Keyword.restore(@keywords[key])
 222       else
 223         # key name order for the lookup through these
 224         @statickeywords.keys.sort.each {|k|
 225           v = @statickeywords[k]
 226           if v.has_key?(key)
 227             return Keyword.restore(v[key])
 228           end
 229         }
 230       end
 231       return nil
 232     end
 233
 234     # does +key+ exist as a keyword?
 235     def has_key?(key)
 236       if @keywords.has_key?(key) && Keyword.restore(@keywords[key]) != nil
 237         return true
 238       end
 239       @statickeywords.each {|k,v|
 240         if v.has_key?(key) && Keyword.restore(v[key]) != nil
 241           return true
 242         end
 243       }
 244       return false
 245     end
 246
 247     # m::     PrivMessage containing message info
 248     # key::   key being queried
 249     # dunno:: optional, if true, reply "dunno" if +key+ not found
 250     #
 251     # handle a message asking about a keyword
 252     def keyword(m, key, dunno=true)
 253        unless(kw = self[key])
 254          m.reply @bot.lang.get("dunno") if (dunno)
 255          return
 256        end
 257        response = kw.to_s
 258        response.gsub!(/<who>/, m.sourcenick)
 259        if(response =~ /^<reply>\s*(.*)/)
 260          m.reply "#$1"
 261        elsif(response =~ /^<action>\s*(.*)/)
 262          @bot.action m.replyto, "#$1"
 263        elsif(m.public? && response =~ /^<topic>\s*(.*)/)
 264          topic = $1
 265          @bot.topic m.target, topic
 266        else
 267          m.reply "#{key} #{kw.type} #{response}"
 268        end
 269     end
 270
 271
 272     # m::      PrivMessage containing message info
 273     # target:: channel/nick to tell about the keyword
 274     # key::    key being queried
 275     #
 276     # handle a message asking the bot to tell someone about a keyword
 277     def keyword_tell(m, target, key)
 278       unless(kw = self[key])
 279         @bot.say m.sourcenick, @bot.lang.get("dunno_about_X") % key
 280         return
 281       end
 282       response = kw.to_s
 283       response.gsub!(/<who>/, m.sourcenick)
 284       if(response =~ /^<reply>\s*(.*)/)
 285         @bot.say target, "#{m.sourcenick} wanted me to tell you: (#{key}) #$1"
 286         m.reply "okay, I told #{target}: (#{key}) #$1"
 287       elsif(response =~ /^<action>\s*(.*)/)
 288         @bot.action target, "#$1 (#{m.sourcenick} wanted me to tell you)"
 289         m.reply "okay, I told #{target}: * #$1"
 290       else
 291         @bot.say target, "#{m.sourcenick} wanted me to tell you that #{key} #{kw.type} #{response}"
 292         m.reply "okay, I told #{target} that #{key} #{kw.type} #{response}"
 293       end
 294     end
 295
 296     # handle a message which alters a keyword
 297     # like "foo is bar", or "no, foo is baz", or "foo is also qux"
 298     def keyword_command(sourcenick, target, lhs, mhs, rhs, quiet=false)
 299       debug "got keyword command #{lhs}, #{mhs}, #{rhs}"
 300       overwrite = false
 301       overwrite = true if(lhs.gsub!(/^no,\s*/, ""))
 302       also = true if(rhs.gsub!(/^also\s+/, ""))
 303       values = rhs.split(/\s+\|\s+/)
 304       lhs = Keyword.unescape lhs
 305       if(overwrite || also || !has_key?(lhs))
 306         if(also && has_key?(lhs))
 307           kw = self[lhs]
 308           kw << values
 309           @keywords[lhs] = kw.dump
 310         else
 311           @keywords[lhs] = Keyword.new(mhs, values).dump
 312         end
 313         @bot.okay target if !quiet
 314       elsif(has_key?(lhs))
 315         kw = self[lhs]
 316         @bot.say target, "but #{lhs} #{kw.type} #{kw.desc}" if kw && !quiet
 317       end
 318     end
 319
 320     # return help string for Keywords with option topic +topic+
 321     def help(topic="")
 322       case topic
 323         when "overview"
 324           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>"
 325         when "set"
 326           return "set => <keyword> is <definition>"
 327         when "plurals"
 328           return "plurals => <keywords> are <definition>"
 329         when "override"
 330           return "overide => no, <keyword> is <definition>"
 331         when "also"
 332           return "also => <keyword> is also <definition>"
 333         when "random"
 334           return "random responses => <keyword> is <definition> | <definition> [| ...]"
 335         when "get"
 336           return "asking for keywords => (with addressing) \"<keyword>?\", (without addressing) \"'<keyword>\""
 337         when "tell"
 338           return "tell <nick> about <keyword> => if <keyword> is known, tell <nick>, via /msg, its definition"
 339         when "forget"
 340           return "forget <keyword> => forget fact <keyword>"
 341         when "keywords"
 342           return "keywords => show current keyword counts"
 343         when "<reply>"
 344           return "<reply> => normal response is \"<keyword> is <definition>\", but if <definition> begins with <reply>, the response will be \"<definition>\""
 345         when "<action>"
 346           return "<action> => makes keyword respnse \"/me <definition>\""
 347         when "<who>"
 348           return "<who> => replaced with questioner in reply"
 349         when "<topic>"
 350           return "<topic> => respond by setting the topic to the rest of the definition"
 351         when "search"
 352           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."
 353         else
 354           return "Keyword module (Fact learning and regurgitation) topics: overview, set, plurals, override, also, random, get, tell, forget, keywords, keywords search, <reply>, <action>, <who>, <topic>"
 355       end
 356     end
 357
 358     # privmsg handler
 359     def privmsg(m)
 360       return if m.replied?
 361       if(m.address?)
 362         if(!(m.message =~ /\\\?\s*$/) && m.message =~ /^(.*\S)\s*\?\s*$/)
 363           keyword m, $1 if(@bot.auth.allow?("keyword", m.source, m.replyto))
 364         elsif(m.message =~ /^(.*?)\s+(is|are)\s+(.*)$/)
 365           keyword_command(m.sourcenick, m.replyto, $1, $2, $3) if(@bot.auth.allow?("keycmd", m.source, m.replyto))
 366         elsif (m.message =~ /^tell\s+(\S+)\s+about\s+(.+)$/)
 367           keyword_tell(m, $1, $2) if(@bot.auth.allow?("keyword", m.source, m.replyto))
 368         elsif (m.message =~ /^forget\s+(.*)$/)
 369           key = $1
 370           if((@bot.auth.allow?("keycmd", m.source, m.replyto)) && @keywords.has_key?(key))
 371             @keywords.delete(key)
 372             @bot.okay m.replyto
 373           end
 374         elsif (m.message =~ /^keywords$/)
 375           if(@bot.auth.allow?("keyword", m.source, m.replyto))
 376             length = 0
 377             @statickeywords.each {|k,v|
 378               length += v.length
 379             }
 380             m.reply "There are currently #{@keywords.length} keywords, #{length} static facts defined."
 381           end
 382         elsif (m.message =~ /^keywords search\s+(.*)$/)
 383           str = $1
 384           all = false
 385           all = true if str.gsub!(/--all\s+/, "")
 386           full = false
 387           full = true if str.gsub!(/--full\s+/, "")
 388
 389           re = Regexp.new(str, Regexp::IGNORECASE)
 390           if(@bot.auth.allow?("keyword", m.source, m.replyto))
 391             matches = Array.new
 392             @keywords.each {|k,v|
 393               kw = Keyword.restore(v)
 394               if re.match(k) || (full && re.match(kw.desc))
 395                 matches << [k,kw]
 396               end
 397             }
 398             if all
 399               @statickeywords.each {|k,v|
 400                 v.each {|kk,vv|
 401                   kw = Keyword.restore(vv)
 402                   if re.match(kk) || (full && re.match(kw.desc))
 403                     matches << [kk,kw]
 404                   end
 405                 }
 406               }
 407             end
 408             if matches.length == 1
 409               rkw = matches[0]
 410               m.reply "#{rkw[0]} #{rkw[1].type} #{rkw[1].desc}"
 411             elsif matches.length > 0
 412               i = 0
 413               matches.each {|rkw|
 414                 m.reply "[#{i+1}/#{matches.length}] #{rkw[0]} #{rkw[1].type} #{rkw[1].desc}"
 415                 i += 1
 416                 break if i == 3
 417               }
 418             else
 419               m.reply "no keywords match #{str}"
 420             end
 421           end
 422         end
 423       else
 424         # in channel message, not to me
 425         # TODO option to do if(m.message =~ /^(.*)$/, ie try any line as a
 426         # keyword lookup.
 427         if(m.message =~ /^'(.*)$/ || (!@bot.config["keyword.address"] && m.message =~ /^(.*\S)\s*\?\s*$/))
 428           keyword m, $1, false if(@bot.auth.allow?("keyword", m.source))
 429         elsif(@bot.config["keyword.listen"] == true && (m.message =~ /^(.*?)\s+(is|are)\s+(.*)$/))
 430           # TODO MUCH more selective on what's allowed here
 431           keyword_command(m.sourcenick, m.replyto, $1, $2, $3, true) if(@bot.auth.allow?("keycmd", m.source))
 432         end
 433       end
 434     end
 435   end
 436 end