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
12 # type of keyword (e.g. "is" or "are")
15 # type:: type of keyword (e.g "is" or "are")
16 # values:: array of values
18 # create a keyword of type +type+ with values +values+
19 def initialize(type, values)
24 # pick a random value for this keyword and return it
26 if(@values.length > 1)
27 Keyword.unescape(@values[rand(@values.length)])
29 Keyword.unescape(@values[0])
33 # describe the keyword (show all values without interpolation)
38 # return the keyword in a stringified form ready for storage
40 @type + "/" + Keyword.unescape(@values.join("<=or=>"))
43 # deserialize the stringified form to an object
44 def Keyword.restore(str)
45 if str =~ /^(\S+?)\/(.*)$/
47 vals = $2.split("<=or=>")
48 return Keyword.new(type, vals)
53 # values:: array of values to add
54 # add values to a keyword
56 if(@values.length > 1 || values.length > 1)
61 @values[0] += " or " + values[0]
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")
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")
78 # Handles all that stuff like "bot: foo is bar", "bot: foo?"
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
84 BotConfig.register BotConfigBooleanValue.new('keyword.listen',
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',
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")
91 # create a new Keywords instance, associated to bot +bot+
94 @statickeywords = Hash.new
96 @keywords = DBTree.new bot, "keyword"
100 # import old format keywords into DBHash
101 if(File.exist?("#{@bot.botclass}/keywords.rbot"))
102 log "auto importing old keywords.rbot"
103 IO.foreach("#{@bot.botclass}/keywords.rbot") do |line|
104 if(line =~ /^(.*?)\s*<=(is|are)?=?>\s*(.*)$/)
108 mhs = "is" unless mhs
109 rhs = Keyword.escape rhs
110 values = rhs.split("<=or=>")
111 @keywords[lhs] = Keyword.new(mhs, values).dump
114 File.delete("#{@bot.botclass}/keywords.rbot")
118 # drop static keywords and reload them from files, picking up any new
119 # keyword files that have been added
121 @statickeywords = Hash.new
125 # load static keywords from files, picking up any new keyword files that
128 # first scan for old DBHash files, and convert them
129 Dir["#{@bot.botclass}/keywords/*"].each {|f|
130 next unless f =~ /\.db$/
131 log "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,
135 new = BDB::CIBtree.open(newname, nil,
136 BDB::CREATE | BDB::EXCL,
146 # then scan for current DBTree files, and load them
147 Dir["#{@bot.botclass}/keywords/*"].each {|f|
148 next unless f =~ /\.kdb$/
149 hsh = DBTree.new @bot, f, true
150 key = File.basename(f).gsub(/\.kdb$/, "")
151 debug "keywords module: loading DBTree file #{f}, key #{key}"
152 @statickeywords[key] = hsh
155 # then scan for non DB files, and convert/import them and delete
156 Dir["#{@bot.botclass}/keywords/*"].each {|f|
157 next if f =~ /\.kdb$/
159 log "auto converting keywords from #{f}"
160 key = File.basename(f)
161 unless @statickeywords.has_key?(key)
162 @statickeywords[key] = DBHash.new @bot, "#{f}.db", true
164 IO.foreach(f) {|line|
165 if(line =~ /^(.*?)\s*<?=(is|are)?=?>\s*(.*)$/)
169 # support infobot style factfiles, by fixing them up here
170 rhs.gsub!(/\$who/, "<who>")
171 mhs = "is" unless mhs
172 rhs = Keyword.escape rhs
173 values = rhs.split("<=or=>")
174 @statickeywords[key][lhs] = Keyword.new(mhs, values).dump
178 @statickeywords[key].flush
182 # upgrade data files found in old rbot formats to current
184 if File.exist?("#{@bot.botclass}/keywords.db")
185 log "upgrading old keywords (rbot 0.9.5 or prior) database format"
186 old = BDB::Hash.open "#{@bot.botclass}/keywords.db", nil,
188 new = BDB::CIBtree.open "#{@bot.botclass}/keyword.db", nil,
189 BDB::CREATE | BDB::EXCL,
196 File.delete("#{@bot.botclass}/keywords.db")
200 # save dynamic keywords to file
205 File.open("#{@bot.botclass}/keywords.rbot", "w") do |file|
206 @keywords.each do |key, value|
207 file.puts "#{key}<=#{value.type}=>#{value.dump}"
212 # lookup keyword +key+, return it or nil
214 return nil if key.nil?
215 debug "keywords module: looking up key #{key}"
216 if(@keywords.has_key?(key))
217 return Keyword.restore(@keywords[key])
219 # key name order for the lookup through these
220 @statickeywords.keys.sort.each {|k|
221 v = @statickeywords[k]
223 return Keyword.restore(v[key])
230 # does +key+ exist as a keyword?
232 if @keywords.has_key?(key) && Keyword.restore(@keywords[key]) != nil
235 @statickeywords.each {|k,v|
236 if v.has_key?(key) && Keyword.restore(v[key]) != nil
243 # m:: PrivMessage containing message info
244 # key:: key being queried
245 # dunno:: optional, if true, reply "dunno" if +key+ not found
247 # handle a message asking about a keyword
248 def keyword(m, key, dunno=true)
250 unless(kw = self[key])
251 m.reply @bot.lang.get("dunno") if (dunno)
255 response.gsub!(/<who>/, m.sourcenick)
256 if(response =~ /^<reply>\s*(.*)/)
258 elsif(response =~ /^<action>\s*(.*)/)
259 @bot.action m.replyto, "#$1"
260 elsif(m.public? && response =~ /^<topic>\s*(.*)/)
262 @bot.topic m.target, topic
264 m.reply "#{key} #{kw.type} #{response}"
269 # m:: PrivMessage containing message info
270 # target:: channel/nick to tell about the keyword
271 # key:: key being queried
273 # handle a message asking the bot to tell someone about a keyword
274 def keyword_tell(m, target, key)
275 unless(kw = self[key])
276 @bot.say m.sourcenick, @bot.lang.get("dunno_about_X") % key
280 response.gsub!(/<who>/, m.sourcenick)
281 if(response =~ /^<reply>\s*(.*)/)
282 @bot.say target, "#{m.sourcenick} wanted me to tell you: (#{key}) #$1"
283 m.reply "okay, I told #{target}: (#{key}) #$1"
284 elsif(response =~ /^<action>\s*(.*)/)
285 @bot.action target, "#$1 (#{m.sourcenick} wanted me to tell you)"
286 m.reply "okay, I told #{target}: * #$1"
288 @bot.say target, "#{m.sourcenick} wanted me to tell you that #{key} #{kw.type} #{response}"
289 m.reply "okay, I told #{target} that #{key} #{kw.type} #{response}"
293 # handle a message which alters a keyword
294 # like "foo is bar", or "no, foo is baz", or "foo is also qux"
295 def keyword_command(sourcenick, target, lhs, mhs, rhs, quiet=false)
296 debug "got keyword command #{lhs}, #{mhs}, #{rhs}"
298 overwrite = true if(lhs.gsub!(/^no,\s*/, ""))
299 also = true if(rhs.gsub!(/^also\s+/, ""))
300 values = rhs.split(/\s+\|\s+/)
301 lhs = Keyword.unescape lhs
302 if(overwrite || also || !has_key?(lhs))
303 if(also && has_key?(lhs))
306 @keywords[lhs] = kw.dump
308 @keywords[lhs] = Keyword.new(mhs, values).dump
310 @bot.okay target if !quiet
313 @bot.say target, "but #{lhs} #{kw.type} #{kw.desc}" if kw && !quiet
317 # return help string for Keywords with option topic +topic+
321 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>"
323 return "set => <keyword> is <definition>"
325 return "plurals => <keywords> are <definition>"
327 return "overide => no, <keyword> is <definition>"
329 return "also => <keyword> is also <definition>"
331 return "random responses => <keyword> is <definition> | <definition> [| ...]"
333 return "asking for keywords => (with addressing) \"<keyword>?\", (without addressing) \"'<keyword>\""
335 return "tell <nick> about <keyword> => if <keyword> is known, tell <nick>, via /msg, its definition"
337 return "forget <keyword> => forget fact <keyword>"
339 return "keywords => show current keyword counts"
341 return "<reply> => normal response is \"<keyword> is <definition>\", but if <definition> begins with <reply>, the response will be \"<definition>\""
343 return "<action> => makes keyword respnse \"/me <definition>\""
345 return "<who> => replaced with questioner in reply"
347 return "<topic> => respond by setting the topic to the rest of the definition"
349 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."
351 return "Keyword module (Fact learning and regurgitation) topics: overview, set, plurals, override, also, random, get, tell, forget, keywords, keywords search, <reply>, <action>, <who>, <topic>"
359 if(!(m.message =~ /\\\?\s*$/) && m.message =~ /^(.*\S)\s*\?\s*$/)
360 keyword m, $1 if(@bot.auth.allow?("keyword", m.source, m.replyto))
361 elsif(m.message =~ /^(.*?)\s+(is|are)\s+(.*)$/)
362 keyword_command(m.sourcenick, m.replyto, $1, $2, $3) if(@bot.auth.allow?("keycmd", m.source, m.replyto))
363 elsif (m.message =~ /^tell\s+(\S+)\s+about\s+(.+)$/)
364 keyword_tell(m, $1, $2) if(@bot.auth.allow?("keyword", m.source, m.replyto))
365 elsif (m.message =~ /^forget\s+(.*)$/)
367 if((@bot.auth.allow?("keycmd", m.source, m.replyto)) && @keywords.has_key?(key))
368 @keywords.delete(key)
371 elsif (m.message =~ /^keywords$/)
372 if(@bot.auth.allow?("keyword", m.source, m.replyto))
374 @statickeywords.each {|k,v|
377 m.reply "There are currently #{@keywords.length} keywords, #{length} static facts defined."
379 elsif (m.message =~ /^keywords search\s+(.*)$/)
382 all = true if str.gsub!(/--all\s+/, "")
384 full = true if str.gsub!(/--full\s+/, "")
387 re = Regexp.new(str, Regexp::IGNORECASE)
388 if(@bot.auth.allow?("keyword", m.source, m.replyto))
390 @keywords.each {|k,v|
391 kw = Keyword.restore(v)
392 if re.match(k) || (full && re.match(kw.desc))
397 @statickeywords.each {|k,v|
399 kw = Keyword.restore(vv)
400 if re.match(kk) || (full && re.match(kw.desc))
406 if matches.length == 1
408 m.reply "#{rkw[0]} #{rkw[1].type} #{rkw[1].desc}"
409 elsif matches.length > 0
412 m.reply "[#{i+1}/#{matches.length}] #{rkw[0]} #{rkw[1].type} #{rkw[1].desc}"
417 m.reply "no keywords match #{str}"
420 rescue RegexpError => e
421 m.reply "no keywords match #{str}: #{e}"
424 m.reply "no keywords match #{str}: an error occurred"
428 # in channel message, not to me
429 # TODO option to do if(m.message =~ /^(.*)$/, ie try any line as a
431 if(m.message =~ /^'(.*)$/ || (!@bot.config["keyword.address"] && m.message =~ /^(.*\S)\s*\?\s*$/))
432 keyword m, $1, false if(@bot.auth.allow?("keyword", m.source))
433 elsif(@bot.config["keyword.listen"] == true && (m.message =~ /^(.*?)\s+(is|are)\s+(.*)$/))
434 # TODO MUCH more selective on what's allowed here
435 keyword_command(m.sourcenick, m.replyto, $1, $2, $3, true) if(@bot.auth.allow?("keycmd", m.source))