]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blob - data/rbot/plugins/markov.rb
markov: document 'learn from <file>'
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / markov.rb
1 #-- vim:sw=2:et
2 #++
3 #
4 # :title: Markov plugin
5 #
6 # Author:: Tom Gilbert <tom@linuxbrit.co.uk>
7 # Copyright:: (C) 2005 Tom Gilbert
8 #
9 # Contribute to chat with random phrases built from word sequences learned
10 # by listening to chat
11
12 class MarkovPlugin < Plugin
13   Config.register Config::BooleanValue.new('markov.enabled',
14     :default => false,
15     :desc => "Enable and disable the plugin")
16   Config.register Config::IntegerValue.new('markov.probability',
17     :default => 25,
18     :validate => Proc.new { |v| (0..100).include? v },
19     :desc => "Percentage chance of markov plugin chipping in")
20   Config.register Config::ArrayValue.new('markov.ignore',
21     :default => [],
22     :desc => "Hostmasks and channel names markov should NOT learn from (e.g. idiot*!*@*, #privchan).")
23   Config.register Config::ArrayValue.new('markov.readonly',
24     :default => [],
25     :desc => "Hostmasks and channel names markov should NOT talk to (e.g. idiot*!*@*, #privchan).")
26   Config.register Config::IntegerValue.new('markov.max_words',
27     :default => 50,
28     :validate => Proc.new { |v| (0..100).include? v },
29     :desc => "Maximum number of words the bot should put in a sentence")
30   Config.register Config::FloatValue.new('markov.learn_delay',
31     :default => 0.5,
32     :validate => Proc.new { |v| v >= 0 },
33     :desc => "Time the learning thread spends sleeping after learning a line. If set to zero, learning from files can be very CPU intensive, but also faster.")
34    Config.register Config::IntegerValue.new('markov.delay',
35     :default => 5,
36     :validate => Proc.new { |v| v >= 0 },
37     :desc => "Wait short time before contributing to conversation.")
38    Config.register Config::IntegerValue.new('markov.answer_addressed',
39     :default => 50,
40     :validate => Proc.new { |v| (0..100).include? v },
41     :desc => "Probability of answer when addressed by nick")
42    Config.register Config::ArrayValue.new('markov.ignore_patterns',
43     :default => [],
44     :desc => "Ignore these word patterns")
45
46   MARKER = :"\r\n"
47
48   # upgrade a registry entry from 0.9.14 and earlier, converting the Arrays
49   # into Hashes of weights
50   def upgrade_entry(k, logfile)
51     logfile.puts "\t#{k.inspect}"
52     logfile.flush
53     logfile.fsync
54
55     ar = @registry[k]
56
57     # wipe the current key
58     @registry.delete(k)
59
60     # discard empty keys
61     if ar.empty?
62       logfile.puts "\tEMPTY"
63       return
64     end
65
66     # otherwise, proceed
67     logfile.puts "\t#{ar.inspect}"
68
69     # re-encode key to UTF-8 and cleanup as needed
70     words = k.split.map do |w|
71       BasicUserMessage.strip_formatting(
72         @bot.socket.filter.in(w)
73       ).sub(/\001$/,'')
74     end
75
76     # old import that failed to split properly?
77     if words.length == 1 and words.first.include? '/'
78       # split at the last /
79       unsplit = words.first
80       at = unsplit.rindex('/')
81       words = [unsplit[0,at], unsplit[at+1..-1]]
82     end
83
84     # if any of the re-split/re-encoded words have spaces,
85     # or are empty, we would get a chain we can't convert,
86     # so drop it
87     if words.first.empty? or words.first.include?(' ') or
88       words.last.empty? or words.last.include?(' ')
89       logfile.puts "\tSKIPPED"
90       return
91     end
92
93     # former unclean CTCP, we can't convert this
94     if words.first[0] == 1
95       logfile.puts "\tSKIPPED"
96       return
97     end
98
99     # nonword CTCP => SKIP
100     # someword CTCP => nonword someword
101     if words.last[0] == 1
102       if words.first == "nonword"
103         logfile.puts "\tSKIPPED"
104         return
105       end
106       words.unshift MARKER
107       words.pop
108     end
109
110     # intern the old keys
111     words.map! do |w|
112       ['nonword', MARKER].include?(w) ? MARKER : w.chomp("\001")
113     end
114
115     newkey = words.join(' ')
116     logfile.puts "\t#{newkey.inspect}"
117
118     # the new key exists already, so we want to merge
119     if k != newkey and @registry.key? newkey
120       ar2 = @registry[newkey]
121       logfile.puts "\tMERGE"
122       logfile.puts "\t\t#{ar2.inspect}"
123       ar.push(*ar2)
124       # and get rid of the key
125       @registry.delete(newkey)
126     end
127
128     total = 0
129     hash = Hash.new(0)
130
131     @chains_mutex.synchronize do
132       if @chains.key? newkey
133         ar2 = @chains[newkey]
134         total += ar2.first
135         hash.update ar2.last
136       end
137
138       ar.each do |word|
139         case word
140         when :nonword
141           # former marker
142           sym = MARKER
143         else
144           # we convert old words into UTF-8, cleanup, resplit if needed,
145           # and only get the first word. we may lose some data for old
146           # missplits, but this is the best we can do
147           w = BasicUserMessage.strip_formatting(
148             @bot.socket.filter.in(word).split.first
149           )
150           case w
151           when /^\001\S+$/, "\001", ""
152             # former unclean CTCP or end of CTCP
153             next
154           else
155             # intern after clearing leftover end-of-actions if present
156             sym = w.chomp("\001")
157           end
158         end
159         hash[sym] += 1
160         total += 1
161       end
162       if hash.empty?
163         logfile.puts "\tSKIPPED"
164         return
165       end
166       logfile.puts "\t#{[total, hash].inspect}"
167       @chains[newkey] = [total, hash]
168     end
169   end
170
171   def upgrade_registry
172     # we load all the keys and then iterate over this array because
173     # running each() on the registry and updating it at the same time
174     # doesn't work
175     keys = @registry.keys
176     # no registry, nothing to do
177     return if keys.empty?
178
179     ki = 0
180     log "starting markov database conversion thread (v1 to v2, #{keys.length} keys)"
181
182     keys.each { |k| @upgrade_queue.push k }
183     @upgrade_queue.push nil
184
185     @upgrade_thread = Thread.new do
186       logfile = File.open(@bot.path('markov-conversion.log'), 'a')
187       logfile.puts "=== conversion thread started #{Time.now} ==="
188       while k = @upgrade_queue.pop
189         ki += 1
190         logfile.puts "Key #{ki} (#{@upgrade_queue.length} in queue):"
191         begin
192           upgrade_entry(k, logfile)
193         rescue Exception => e
194           logfile.puts "=== ERROR ==="
195           logfile.puts e.pretty_inspect
196           logfile.puts "=== EREND ==="
197         end
198         sleep @bot.config['markov.learn_delay'] unless @bot.config['markov.learn_delay'].zero?
199       end
200       logfile.puts "=== conversion thread stopped #{Time.now} ==="
201       logfile.close
202     end
203     @upgrade_thread.priority = -1
204   end
205
206   attr_accessor :chains
207
208   def initialize
209     super
210     @registry.set_default([])
211     if @registry.has_key?('enabled')
212       @bot.config['markov.enabled'] = @registry['enabled']
213       @registry.delete('enabled')
214     end
215     if @registry.has_key?('probability')
216       @bot.config['markov.probability'] = @registry['probability']
217       @registry.delete('probability')
218     end
219     if @bot.config['markov.ignore_users']
220       debug "moving markov.ignore_users to markov.ignore"
221       @bot.config['markov.ignore'] = @bot.config['markov.ignore_users'].dup
222       @bot.config.delete('markov.ignore_users'.to_sym)
223     end
224
225     @chains = @registry.sub_registry('v2')
226     @chains.set_default([])
227     @rchains = @registry.sub_registry('v2r')
228     @rchains.set_default([])
229     @chains_mutex = Mutex.new
230     @rchains_mutex = Mutex.new
231
232     @upgrade_queue = Queue.new
233     @upgrade_thread = nil
234     upgrade_registry
235
236     @learning_queue = Queue.new
237     @learning_thread = Thread.new do
238       while s = @learning_queue.pop
239         learn_line s
240         sleep @bot.config['markov.learn_delay'] unless @bot.config['markov.learn_delay'].zero?
241       end
242     end
243     @learning_thread.priority = -1
244   end
245
246   def cleanup
247     if @upgrade_thread and @upgrade_thread.alive?
248       debug 'closing conversion thread'
249       @upgrade_queue.clear
250       @upgrade_queue.push nil
251       @upgrade_thread.join
252       debug 'conversion thread closed'
253     end
254
255     debug 'closing learning thread'
256     @learning_queue.clear
257     @learning_queue.push nil
258     @learning_thread.join
259     debug 'learning thread closed'
260     @chains.close
261     @rchains.close
262     super
263   end
264
265   # pick a word from the registry using the pair as key.
266   def pick_word(word1, word2=MARKER, chainz=@chains)
267     k = "#{word1} #{word2}"
268     return MARKER unless chainz.key? k
269     wordlist = chainz[k]
270     pick_word_from_list wordlist
271   end
272
273   # pick a word from weighted hash
274   def pick_word_from_list(wordlist)
275     total = wordlist.first
276     hash = wordlist.last
277     return MARKER if total == 0
278     return hash.keys.first if hash.length == 1
279     hit = rand(total)
280     ret = MARKER
281     hash.each do |k, w|
282       hit -= w
283       if hit < 0
284         ret = k
285         break
286       end
287     end
288     return ret
289   end
290
291   def generate_string(word1, word2)
292     # limit to max of markov.max_words words
293     if word2
294       output = [word1, word2]
295     else
296       output = word1
297       keys = []
298       @chains.each_key(output) do |key|
299         if key.downcase.include? output
300           keys << key
301         else
302           break
303         end
304       end
305       return nil if keys.empty?
306       output = keys[rand(keys.size)].split(/ /)
307     end
308     output = output.split(/ /) unless output.is_a? Array
309     input = [word1, word2]
310     while output.length < @bot.config['markov.max_words'] and (output.first != MARKER or output.last != MARKER) do
311       if output.last != MARKER
312         output << pick_word(output[-2], output[-1])
313       end
314       if output.first != MARKER
315         output.insert 0, pick_word(output[0], output[1], @rchains)
316       end
317     end
318     output.delete MARKER
319     if output == input
320       nil
321     else
322       output.join(" ")
323     end
324   end
325
326   def help(plugin, topic="")
327     topic, subtopic = topic.split
328
329     case topic
330     when "delay"
331       "markov delay <value> => Set message delay"
332     when "ignore"
333       case subtopic
334       when "add"
335         "markov ignore add <hostmask|channel> => ignore a hostmask or a channel"
336       when "list"
337         "markov ignore list => show ignored hostmasks and channels"
338       when "remove"
339         "markov ignore remove <hostmask|channel> => unignore a hostmask or channel"
340       else
341         "ignore hostmasks or channels -- topics: add, remove, list"
342       end
343     when "readonly"
344       case subtopic
345       when "add"
346         "markov readonly add <hostmask|channel> => read-only a hostmask or a channel"
347       when "list"
348         "markov readonly list => show read-only hostmasks and channels"
349       when "remove"
350         "markov readonly remove <hostmask|channel> => unreadonly a hostmask or channel"
351       else
352         "restrict hostmasks or channels to read only -- topics: add, remove, list"
353       end
354     when "status"
355       "markov status => show if markov is enabled, probability and amount of messages in queue for learning"
356     when "probability"
357       "markov probability [<percent>] => set the % chance of rbot responding to input, or display the current probability"
358     when "chat"
359       case subtopic
360       when "about"
361         "markov chat about <word> [<another word>] => talk about <word> or riff on a word pair (if possible)"
362       else
363         "markov chat => try to say something intelligent"
364       end
365     when "learn"
366       ["markov learn from <file> [testing [<num> lines]] [using pattern <pattern>]:",
367        "learn from the text in the specified <file>, optionally using the given <pattern> to filter the text.",
368        "you can sample what would be learned by specifying 'testing <num> lines'"].join(' ')
369     else
370       "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, readonly, delay, status, probability, chat, chat about"
371     end
372   end
373
374   def clean_message(m)
375     str = m.plainmessage.dup
376     str =~ /^(\S+)([:,;])/
377     if $1 and m.target.is_a? Irc::Channel and m.target.user_nicks.include? $1.downcase
378       str.gsub!(/^(\S+)([:,;])\s+/, "")
379     end
380     str.gsub!(/\s{2,}/, ' ') # fix for two or more spaces
381     return str.strip
382   end
383
384   def probability?
385     return @bot.config['markov.probability']
386   end
387
388   def status(m,params)
389     if @bot.config['markov.enabled']
390       reply = _("markov is currently enabled, %{p}% chance of chipping in") % { :p => probability? }
391       l = @learning_queue.length
392       reply << (_(", %{l} messages in queue") % {:l => l}) if l > 0
393       l = @upgrade_queue.length
394       reply << (_(", %{l} chains to upgrade") % {:l => l}) if l > 0
395     else
396       reply = _("markov is currently disabled")
397     end
398     m.reply reply
399   end
400
401   def ignore?(m=nil)
402     return false unless m
403     return true if m.private?
404     return true if m.prefixed?
405     @bot.config['markov.ignore'].each do |mask|
406       return true if m.channel.downcase == mask.downcase
407       return true if m.source.matches?(mask)
408     end
409     return false
410   end
411
412   def readonly?(m=nil)
413     return false unless m
414     @bot.config['markov.readonly'].each do |mask|
415       return true if m.channel.downcase == mask.downcase
416       return true if m.source.matches?(mask)
417     end
418     return false
419   end
420
421   def ignore(m, params)
422     action = params[:action]
423     user = params[:option]
424     case action
425     when 'remove'
426       if @bot.config['markov.ignore'].include? user
427         s = @bot.config['markov.ignore']
428         s.delete user
429         @bot.config['ignore'] = s
430         m.reply _("%{u} removed") % { :u => user }
431       else
432         m.reply _("not found in list")
433       end
434     when 'add'
435       if user
436         if @bot.config['markov.ignore'].include?(user)
437           m.reply _("%{u} already in list") % { :u => user }
438         else
439           @bot.config['markov.ignore'] = @bot.config['markov.ignore'].push user
440           m.reply _("%{u} added to markov ignore list") % { :u => user }
441         end
442       else
443         m.reply _("give the name of a person or channel to ignore")
444       end
445     when 'list'
446       m.reply _("I'm ignoring %{ignored}") % { :ignored => @bot.config['markov.ignore'].join(", ") }
447     else
448       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")
449     end
450   end
451
452   def readonly(m, params)
453     action = params[:action]
454     user = params[:option]
455     case action
456     when 'remove'
457       if @bot.config['markov.readonly'].include? user
458         s = @bot.config['markov.readonly']
459         s.delete user
460         @bot.config['markov.readonly'] = s
461         m.reply _("%{u} removed") % { :u => user }
462       else
463         m.reply _("not found in list")
464       end
465     when 'add'
466       if user
467         if @bot.config['markov.readonly'].include?(user)
468           m.reply _("%{u} already in list") % { :u => user }
469         else
470           @bot.config['markov.readonly'] = @bot.config['markov.readonly'].push user
471           m.reply _("%{u} added to markov readonly list") % { :u => user }
472         end
473       else
474         m.reply _("give the name of a person or channel to read only")
475       end
476     when 'list'
477       m.reply _("I'm only reading %{readonly}") % { :readonly => @bot.config['markov.readonly'].join(", ") }
478     else
479       m.reply _("have markov not answer to input from a hostmask or a channel. usage: markov readonly add <mask or channel>; markov readonly remove <mask or channel>; markov readonly list")
480     end
481   end
482
483   def enable(m, params)
484     @bot.config['markov.enabled'] = true
485     m.okay
486   end
487
488   def probability(m, params)
489     if params[:probability]
490       @bot.config['markov.probability'] = params[:probability].to_i
491       m.okay
492     else
493       m.reply _("markov has a %{prob}% chance of chipping in") % { :prob => probability? }
494     end
495   end
496
497   def disable(m, params)
498     @bot.config['markov.enabled'] = false
499     m.okay
500   end
501
502   def should_talk(m)
503     return false unless @bot.config['markov.enabled']
504     prob = m.address? ? @bot.config['markov.answer_addressed'] : probability?
505     return true if prob > rand(100)
506     return false
507   end
508
509   # Generates all sequence pairs from array
510   # seq_pairs [1,2,3,4] == [ [1,2], [2,3], [3,4]]
511   def seq_pairs(arr)
512     res = []
513     0.upto(arr.size-2) do |i|
514       res << [arr[i], arr[i+1]]
515     end
516     res
517   end
518
519   def set_delay(m, params)
520     if params[:delay] == "off"
521       @bot.config["markov.delay"] = 0
522       m.okay
523     elsif !params[:delay]
524       m.reply _("Message delay is %{delay}" % { :delay => @bot.config["markov.delay"]})
525     else
526       @bot.config["markov.delay"] = params[:delay].to_i
527       m.okay
528     end
529   end
530
531   def reply_delay(m, line)
532     m.replied = true
533     if @bot.config['markov.delay'] > 0
534       @bot.timer.add_once(1 + rand(@bot.config['markov.delay'])) {
535         m.reply line, :nick => false, :to => :public
536       }
537     else
538       m.reply line, :nick => false, :to => :public
539     end
540   end
541
542   def random_markov(m, message)
543     return unless should_talk(m)
544
545     words = clean_message(m).split(/\s+/)
546     if words.length < 2
547       line = generate_string words.first, nil
548
549       if line and message.index(line) != 0
550         reply_delay m, line
551         return
552       end
553     else
554       pairs = seq_pairs(words).sort_by { rand }
555       pairs.each do |word1, word2|
556         line = generate_string(word1, word2)
557         if line and message.index(line) != 0
558           reply_delay m, line
559           return
560         end
561       end
562       words.sort_by { rand }.each do |word|
563         line = generate_string word.first, nil
564         if line and message.index(line) != 0
565           reply_delay m, line
566           return
567         end
568       end
569     end
570   end
571
572   def chat(m, params)
573     line = generate_string(params[:seed1], params[:seed2])
574     if line and line != [params[:seed1], params[:seed2]].compact.join(" ")
575       m.reply line
576     else
577       m.reply _("I can't :(")
578     end
579   end
580
581   def rand_chat(m, params)
582     # pick a random pair from the db and go from there
583     word1, word2 = MARKER, MARKER
584     output = Array.new
585     @bot.config['markov.max_words'].times do
586       word3 = pick_word(word1, word2)
587       break if word3 == MARKER
588       output << word3
589       word1, word2 = word2, word3
590     end
591     if output.length > 1
592       m.reply output.join(" ")
593     else
594       m.reply _("I can't :(")
595     end
596   end
597
598   def learn(*lines)
599     lines.each { |l| @learning_queue.push l }
600   end
601
602   def unreplied(m)
603     return if ignore? m
604
605     # in channel message, the kind we are interested in
606     message = m.plainmessage
607
608     if m.action?
609       message = "#{m.sourcenick} #{message}"
610     end
611
612     random_markov(m, message) unless readonly? m or m.replied?
613     learn clean_message(m)
614   end
615
616
617   def learn_triplet(word1, word2, word3)
618       k = "#{word1} #{word2}"
619       rk = "#{word2} #{word3}"
620       @chains_mutex.synchronize do
621         total = 0
622         hash = Hash.new(0)
623         if @chains.key? k
624           t2, h2 = @chains[k]
625           total += t2
626           hash.update h2
627         end
628         hash[word3] += 1
629         total += 1
630         @chains[k] = [total, hash]
631       end
632       @rchains_mutex.synchronize do
633         # Reverse
634         total = 0
635         hash = Hash.new(0)
636         if @rchains.key? rk
637           t2, h2 = @rchains[rk]
638           total += t2
639           hash.update h2
640         end
641         hash[word1] += 1
642         total += 1
643         @rchains[rk] = [total, hash]
644       end
645   end
646
647
648   def learn_line(message)
649     # debug "learning #{message.inspect}"
650     wordlist = message.strip.split(/\s+/).reject do |w|
651       @bot.config['markov.ignore_patterns'].map do |pat|
652         w =~ Regexp.new(pat.to_s)
653       end.select{|v| v}.size != 0
654     end
655     return unless wordlist.length >= 2
656     word1, word2 = MARKER, MARKER
657     wordlist << MARKER
658     wordlist.each do |word3|
659       learn_triplet(word1, word2, word3.to_sym)
660       word1, word2 = word2, word3
661     end
662   end
663
664   # TODO allow learning from URLs
665   def learn_from(m, params)
666     begin
667       path = params[:file]
668       file = File.open(path, "r")
669       pattern = params[:pattern].empty? ? nil : Regexp.new(params[:pattern].to_s)
670     rescue Errno::ENOENT
671       m.reply _("no such file")
672       return
673     end
674
675     if file.eof?
676       m.reply _("the file is empty!")
677       return
678     end
679
680     if params[:testing]
681       lines = []
682       range = case params[:lines]
683       when /^\d+\.\.\d+$/
684         Range.new(*params[:lines].split("..").map { |e| e.to_i })
685       when /^\d+$/
686         Range.new(1, params[:lines].to_i)
687       else
688         Range.new(1, [@bot.config['send.max_lines'], 3].max)
689       end
690
691       file.each do |line|
692         next unless file.lineno >= range.begin
693         lines << line.chomp
694         break if file.lineno == range.end
695       end
696
697       lines = lines.map do |l|
698         pattern ? l.scan(pattern).to_s : l
699       end.reject { |e| e.empty? }
700
701       if pattern
702         unless lines.empty?
703           m.reply _("example matches for that pattern at lines %{range} include: %{lines}") % {
704             :lines => lines.map { |e| Underline+e+Underline }.join(", "),
705             :range => range.to_s
706           }
707         else
708           m.reply _("the pattern doesn't match anything at lines %{range}") % {
709             :range => range.to_s
710           }
711         end
712       else
713         m.reply _("learning from the file without a pattern would learn, for example: ")
714         lines.each { |l| m.reply l }
715       end
716
717       return
718     end
719
720     if pattern
721       file.each { |l| learn(l.scan(pattern).to_s) }
722     else
723       file.each { |l| learn(l.chomp) }
724     end
725
726     m.okay
727   end
728
729   def stats(m, params)
730     m.reply "Markov status: chains: #{@chains.length} forward, #{@rchains.length} reverse, queued phrases: #{@learning_queue.size}"
731   end
732
733 end
734
735 plugin = MarkovPlugin.new
736 plugin.map 'markov delay :delay', :action => "set_delay"
737 plugin.map 'markov delay', :action => "set_delay"
738 plugin.map 'markov ignore :action :option', :action => "ignore"
739 plugin.map 'markov ignore :action', :action => "ignore"
740 plugin.map 'markov ignore', :action => "ignore"
741 plugin.map 'markov readonly :action :option', :action => "readonly"
742 plugin.map 'markov readonly :action', :action => "readonly"
743 plugin.map 'markov readonly', :action => "readonly"
744 plugin.map 'markov enable', :action => "enable"
745 plugin.map 'markov disable', :action => "disable"
746 plugin.map 'markov status', :action => "status"
747 plugin.map 'markov stats', :action => "stats"
748 plugin.map 'chat about :seed1 [:seed2]', :action => "chat"
749 plugin.map 'chat', :action => "rand_chat"
750 plugin.map 'markov probability [:probability]', :action => "probability",
751            :requirements => {:probability => /^\d+%?$/}
752 plugin.map 'markov learn from :file [:testing [:lines lines]] [using pattern *pattern]', :action => "learn_from", :thread => true,
753            :requirements => {
754              :testing => /^testing$/,
755              :lines   => /^(?:\d+\.\.\d+|\d+)$/ }
756
757 plugin.default_auth('ignore', false)
758 plugin.default_auth('probability', false)
759 plugin.default_auth('learn', false)
760