#
# Store (and retrieve) unstructured one-sentence factoids
-class FactoidsPlugin < Plugin
- class Factoid
- def initialize(hash)
- @hash = hash.reject { |k, val| val.nil? or val.empty? rescue false }
- raise ArgumentError, "no fact!" unless @hash[:fact]
- if String === @hash[:when]
- @hash[:when] = Time.parse @hash[:when]
- end
+class ::Factoid
+ def initialize(hash)
+ @hash = hash.reject { |k, val| val.nil? or val.empty? rescue false }
+ raise ArgumentError, "no fact!" unless @hash[:fact]
+ if String === @hash[:when]
+ @hash[:when] = Time.parse @hash[:when]
end
+ end
- def to_s(opts={})
- show_meta = opts[:meta]
- fact = @hash[:fact]
- if !show_meta
- return fact
- end
- meta = ""
- metadata = []
- if @hash[:who]
- metadata << _("from %{who}" % @hash)
- end
- if @hash[:when]
- metadata << _("on %{when}" % @hash)
- end
- if @hash[:where]
- metadata << _("in %{where}" % @hash)
- end
- unless metadata.empty?
- meta << _(" [%{data}]" % {:data => metadata.join(" ")})
- end
- return fact+meta
+ def to_s(opts={})
+ show_meta = opts[:meta]
+ fact = @hash[:fact]
+ if !show_meta
+ return fact
end
-
- def [](*args)
- @hash[*args]
+ meta = ""
+ metadata = []
+ if @hash[:who]
+ metadata << _("from %{who}" % @hash)
end
-
- def []=(*args)
- @hash.send(:[]=,*args)
+ if @hash[:when]
+ metadata << _("on %{when}" % @hash)
end
-
- def to_hsh
- return @hash
+ if @hash[:where]
+ metadata << _("in %{where}" % @hash)
+ end
+ unless metadata.empty?
+ meta << _(" [%{data}]" % {:data => metadata.join(" ")})
end
- alias :to_hash :to_hsh
+ return fact+meta
end
- class FactoidList < ArrayOf
- def initialize(ar=[])
- super(Factoid, ar)
- end
+ def [](*args)
+ @hash[*args]
+ end
- def index(f)
- fact = f.to_s
- return if fact.empty?
- self.map { |f| f[:fact] }.index(fact)
- end
+ def []=(*args)
+ @hash.send(:[]=,*args)
+ end
- def delete(f)
- idx = index(f)
- return unless idx
- self.delete_at(idx)
- end
+ def to_hsh
+ return @hash
+ end
+ alias :to_hash :to_hsh
+end
- def grep(x)
- self.find_all { |f|
- x === f[:fact]
- }
- end
+class ::FactoidList < ArrayOf
+ def initialize(ar=[])
+ super(Factoid, ar)
end
+ def index(f)
+ fact = f.to_s
+ return if fact.empty?
+ self.map { |fs| fs[:fact] }.index(fact)
+ end
+
+ def delete(f)
+ idx = index(f)
+ return unless idx
+ self.delete_at(idx)
+ end
+
+ def grep(x)
+ self.find_all { |f|
+ x === f[:fact]
+ }
+ end
+end
+
+class FactoidsPlugin < Plugin
# TODO default should be language-specific
Config.register Config::ArrayValue.new('factoids.trigger_pattern',
:default => [
],
:on_change => Proc.new { |bot, v| bot.plugins['factoids'].reset_triggers },
:desc => "A list of regular expressions matching factoids where keywords can be identified. append ':n' if the keyword is defined by the n-th group instead of the first. if the list is empty, any word will be considered a keyword")
+ Config.register Config::ArrayValue.new('factoids.not_triggers',
+ :default => [
+ "this","that","the","a","right","who","what","why"
+ ],
+ :on_change => Proc.new { |bot, v| bot.plugins['factoids'].reset_triggers },
+ :desc => "A list of words that won't be set as keywords")
Config.register Config::BooleanValue.new('factoids.address',
:default => true,
:desc => "Should the bot reply with relevant factoids only when addressed with a direct question? If not, the bot will attempt to lookup foo if someone says 'foo?' in channel")
def initialize
super
- # TODO config
- @dir = File.join(@bot.botclass,"factoids")
- @filename = "factoids.rbot"
- @factoids = FactoidList.new
@triggers = Set.new
@learn_patterns = []
- reset_learn_patterns
- begin
- read_factfile
- rescue
- debug $!
+
+ @factoids = @registry[:factoids]
+ unless @factoids
+ @factoids = FactoidList.new
+
+ @dir = datafile
+ @filename = "factoids.rbot"
+ debug "migrate from existing factoids #{@dir}/#{@filename}"
+ reset_learn_patterns
+ begin
+ read_factfile
+ rescue
+ debug $!
+ end
+ @changed = true
+ else
+ reset_learn_patterns
+ reset_triggers
+ @changed = false
end
- @changed = false
end
def read_factfile(name=@filename,dir=@dir)
def save
return unless @changed
- Dir.mkdir(@dir) unless FileTest.directory?(@dir)
- fname = File.join(@dir,@filename)
- ar = ["when | who | where | fact"]
- @factoids.each { |f|
- ar << "%s | %s | %s | %s" % [ f[:when], f[:who], f[:where], f[:fact]]
- }
- Utils.safe_save(fname) do |file|
- file.puts ar
- end
+ @registry[:factoids] = @factoids
+ @registry.flush
@changed = false
end
end
}
debug "Triggers done in #{Time.now - start_time}"
- @triggers.replace(triggers)
+ @triggers.replace(triggers - @bot.config['factoids.not_triggers'])
end
def reset_learn_patterns
end
def help(plugin, topic="")
- _("factoids plugin: learn that <factoid>, forget that <factoids>, facts about <words>")
+ case plugin
+ when 'learn'
+ _("learn that <factoid> => learn a factoid")
+ when 'forget'
+ _("forget fact <#num> => forget factoid number #num ; forget about <factoid> => forget a factoid")
+ else
+ _("factoids plugin: learn that <factoid>, forget that <factoid>, facts about <words>")
+ end
end
def learn(m, params)
# When looking for words we separate them with
# arbitrary whitespace, not whatever they came with
pre = words.map { |w| Regexp.escape(w)}.join("\\s+")
- return Regexp.new("\\b#{pre}\\b", true)
+ pre << '\b' if pre.match(/\b$/)
+ pre = '\b' + pre if pre.match(/^\b/)
+ return Regexp.new(pre, true)
end
def facts(m, params)
if params[:words].nil_or_empty? and params[:rx].nil_or_empty?
m.reply _("I know %{total} facts" % { :total => total })
else
- if params[:words].empty?
+ unless params.key? :words and not params[:words].empty?
rx = Regexp.new(params[:rx].to_s, true)
else
rx = words2rx(params[:words])
known = @factoids.grep(rx)
reply = []
if known.empty?
- reply << _("I know nothing about %{words}" % params)
+ if params.key? :words
+ reply << _("I know nothing about %{words}" % params)
+ else params.key? :rx
+ reply << _("I know nothing matching %{rx}" % params)
+ end
else
max_facts = @bot.config['factoids.search_results']
len = known.length
reply << short_fact(f)
}
end
- m.reply reply.join(". "), :split_at => /\s+--\s+/
+ m.reply reply.join(". "), :split_at => /\[\d+\/\d+\] /, :purge_split => false
end
end
return if @triggers.empty?
query = $1.strip.downcase
if @triggers.include?(query)
- facts(m, :words => query.split)
+ words = query.split
+ words.instance_variable_set(:@string_value, query)
+ def words.to_s
+ @string_value
+ end
+ facts(m, :words => words)
end
else
return if m.address? # we don't learn stuff directed at us which is not an explicit learn command
projects / user / henk / code / ruby / rbot.git / blobdiff