]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blob - data/rbot/plugins/markov.rb
markov: detect addressing-by-nick in channel
[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
230     @upgrade_queue = Queue.new
231     @upgrade_thread = nil
232     upgrade_registry
233
234     @learning_queue = Queue.new
235     @learning_thread = Thread.new do
236       while s = @learning_queue.pop
237         learn_line s
238         sleep @bot.config['markov.learn_delay'] unless @bot.config['markov.learn_delay'].zero?
239       end
240     end
241     @learning_thread.priority = -1
242   end
243
244   def cleanup
245     if @upgrade_thread and @upgrade_thread.alive?
246       debug 'closing conversion thread'
247       @upgrade_queue.clear
248       @upgrade_queue.push nil
249       @upgrade_thread.join
250       debug 'conversion thread closed'
251     end
252
253     debug 'closing learning thread'
254     @learning_queue.clear
255     @learning_queue.push nil
256     @learning_thread.join
257     debug 'learning thread closed'
258     @chains.close
259     @rchains.close
260     super
261   end
262
263   # pick a word from the registry using the pair as key.
264   def pick_word(word1, word2=MARKER, chainz=@chains)
265     k = "#{word1} #{word2}"
266     return MARKER unless chainz.key? k
267     wordlist = chainz[k]
268     pick_word_from_list wordlist
269   end
270
271   # pick a word from weighted hash
272   def pick_word_from_list(wordlist)
273     total = wordlist.first
274     hash = wordlist.last
275     return MARKER if total == 0
276     return hash.keys.first if hash.length == 1
277     hit = rand(total)
278     ret = MARKER
279     hash.each do |k, w|
280       hit -= w
281       if hit < 0
282         ret = k
283         break
284       end
285     end
286     return ret
287   end
288
289   def generate_string(word1, word2)
290     # limit to max of markov.max_words words
291     if word2
292       output = [word1, word2]
293     else
294       output = word1
295       keys = []
296       @chains.each_key(output) do |key|
297         if key.downcase.include? output
298           keys << key
299         else
300           break
301         end
302       end
303       return nil if keys.empty?
304       output = keys[rand(keys.size)].split(/ /)
305     end
306     output = output.split(/ /) unless output.is_a? Array
307     input = [word1, word2]
308     while output.length < @bot.config['markov.max_words'] and (output.first != MARKER or output.last != MARKER) do
309       if output.last != MARKER
310         output << pick_word(output[-2], output[-1])
311       end
312       if output.first != MARKER
313         output.insert 0, pick_word(output[0], output[1], @rchains)
314       end
315     end
316     output.delete MARKER
317     if output == input
318       nil
319     else
320       output.join(" ")
321     end
322   end
323
324   def help(plugin, topic="")
325     topic, subtopic = topic.split
326
327     case topic
328     when "delay"
329       "markov delay <value> => Set message delay"
330     when "ignore"
331       case subtopic
332       when "add"
333         "markov ignore add <hostmask|channel> => ignore a hostmask or a channel"
334       when "list"
335         "markov ignore list => show ignored hostmasks and channels"
336       when "remove"
337         "markov ignore remove <hostmask|channel> => unignore a hostmask or channel"
338       else
339         "ignore hostmasks or channels -- topics: add, remove, list"
340       end
341     when "readonly"
342       case subtopic
343       when "add"
344         "markov readonly add <hostmask|channel> => read-only a hostmask or a channel"
345       when "list"
346         "markov readonly list => show read-only hostmasks and channels"
347       when "remove"
348         "markov readonly remove <hostmask|channel> => unreadonly a hostmask or channel"
349       else
350         "restrict hostmasks or channels to read only -- topics: add, remove, list"
351       end
352     when "status"
353       "markov status => show if markov is enabled, probability and amount of messages in queue for learning"
354     when "probability"
355       "markov probability [<percent>] => set the % chance of rbot responding to input, or display the current probability"
356     when "chat"
357       case subtopic
358       when "about"
359         "markov chat about <word> [<another word>] => talk about <word> or riff on a word pair (if possible)"
360       else
361         "markov chat => try to say something intelligent"
362       end
363     else
364       "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"
365     end
366   end
367
368   def clean_message(m)
369     str = m.plainmessage.dup
370     str =~ /^(\S+)([:,;])/
371     if $1 and m.target.is_a? Irc::Channel and m.target.user_nicks.include? $1.downcase
372       str.gsub!(/^(\S+)([:,;])\s+/, "")
373     end
374     str.gsub!(/\s{2,}/, ' ') # fix for two or more spaces
375     return str.strip
376   end
377
378   def probability?
379     return @bot.config['markov.probability']
380   end
381
382   def status(m,params)
383     if @bot.config['markov.enabled']
384       reply = _("markov is currently enabled, %{p}% chance of chipping in") % { :p => probability? }
385       l = @learning_queue.length
386       reply << (_(", %{l} messages in queue") % {:l => l}) if l > 0
387       l = @upgrade_queue.length
388       reply << (_(", %{l} chains to upgrade") % {:l => l}) if l > 0
389     else
390       reply = _("markov is currently disabled")
391     end
392     m.reply reply
393   end
394
395   def ignore?(m=nil)
396     return false unless m
397     return true if m.private?
398     return true if m.prefixed?
399     @bot.config['markov.ignore'].each do |mask|
400       return true if m.channel.downcase == mask.downcase
401       return true if m.source.matches?(mask)
402     end
403     return false
404   end
405
406   def readonly?(m=nil)
407     return false unless m
408     @bot.config['markov.readonly'].each do |mask|
409       return true if m.channel.downcase == mask.downcase
410       return true if m.source.matches?(mask)
411     end
412     return false
413   end
414
415   def ignore(m, params)
416     action = params[:action]
417     user = params[:option]
418     case action
419     when 'remove'
420       if @bot.config['markov.ignore'].include? user
421         s = @bot.config['markov.ignore']
422         s.delete user
423         @bot.config['ignore'] = s
424         m.reply _("%{u} removed") % { :u => user }
425       else
426         m.reply _("not found in list")
427       end
428     when 'add'
429       if user
430         if @bot.config['markov.ignore'].include?(user)
431           m.reply _("%{u} already in list") % { :u => user }
432         else
433           @bot.config['markov.ignore'] = @bot.config['markov.ignore'].push user
434           m.reply _("%{u} added to markov ignore list") % { :u => user }
435         end
436       else
437         m.reply _("give the name of a person or channel to ignore")
438       end
439     when 'list'
440       m.reply _("I'm ignoring %{ignored}") % { :ignored => @bot.config['markov.ignore'].join(", ") }
441     else
442       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")
443     end
444   end
445
446   def readonly(m, params)
447     action = params[:action]
448     user = params[:option]
449     case action
450     when 'remove'
451       if @bot.config['markov.readonly'].include? user
452         s = @bot.config['markov.readonly']
453         s.delete user
454         @bot.config['markov.readonly'] = s
455         m.reply _("%{u} removed") % { :u => user }
456       else
457         m.reply _("not found in list")
458       end
459     when 'add'
460       if user
461         if @bot.config['markov.readonly'].include?(user)
462           m.reply _("%{u} already in list") % { :u => user }
463         else
464           @bot.config['markov.readonly'] = @bot.config['markov.readonly'].push user
465           m.reply _("%{u} added to markov readonly list") % { :u => user }
466         end
467       else
468         m.reply _("give the name of a person or channel to read only")
469       end
470     when 'list'
471       m.reply _("I'm only reading %{readonly}") % { :readonly => @bot.config['markov.readonly'].join(", ") }
472     else
473       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")
474     end
475   end
476
477   def enable(m, params)
478     @bot.config['markov.enabled'] = true
479     m.okay
480   end
481
482   def probability(m, params)
483     if params[:probability]
484       @bot.config['markov.probability'] = params[:probability].to_i
485       m.okay
486     else
487       m.reply _("markov has a %{prob}% chance of chipping in") % { :prob => probability? }
488     end
489   end
490
491   def disable(m, params)
492     @bot.config['markov.enabled'] = false
493     m.okay
494   end
495
496   def should_talk(m)
497     return false unless @bot.config['markov.enabled']
498     prob = m.address? ? @bot.config['markov.answer_addressed'] : probability?
499     return true if prob > rand(100)
500     return false
501   end
502
503   # Generates all sequence pairs from array
504   # seq_pairs [1,2,3,4] == [ [1,2], [2,3], [3,4]]
505   def seq_pairs(arr)
506     res = []
507     0.upto(arr.size-2) do |i|
508       res << [arr[i], arr[i+1]]
509     end
510     res
511   end
512
513   def set_delay(m, params)
514     if params[:delay] == "off"
515       @bot.config["markov.delay"] = 0
516       m.okay
517     elsif !params[:delay]
518       m.reply _("Message delay is %{delay}" % { :delay => @bot.config["markov.delay"]})
519     else
520       @bot.config["markov.delay"] = params[:delay].to_i
521       m.okay
522     end
523   end
524
525   def reply_delay(m, line)
526     m.replied = true
527     if @bot.config['markov.delay'] > 0
528       @bot.timer.add_once(1 + rand(@bot.config['markov.delay'])) {
529         m.reply line, :nick => false, :to => :public
530       }
531     else
532       m.reply line, :nick => false, :to => :public
533     end
534   end
535
536   def random_markov(m, message)
537     return unless should_talk(m)
538
539     words = clean_message(m).split(/\s+/)
540     if words.length < 2
541       line = generate_string words.first, nil
542
543       if line and message.index(line) != 0
544         reply_delay m, line
545         return
546       end
547     else
548       pairs = seq_pairs(words).sort_by { rand }
549       pairs.each do |word1, word2|
550         line = generate_string(word1, word2)
551         if line and message.index(line) != 0
552           reply_delay m, line
553           return
554         end
555       end
556       words.sort_by { rand }.each do |word|
557         line = generate_string word.first, nil
558         if line and message.index(line) != 0
559           reply_delay m, line
560           return
561         end
562       end
563     end
564   end
565
566   def chat(m, params)
567     line = generate_string(params[:seed1], params[:seed2])
568     if line and line != [params[:seed1], params[:seed2]].compact.join(" ")
569       m.reply line
570     else
571       m.reply _("I can't :(")
572     end
573   end
574
575   def rand_chat(m, params)
576     # pick a random pair from the db and go from there
577     word1, word2 = MARKER, MARKER
578     output = Array.new
579     @bot.config['markov.max_words'].times do
580       word3 = pick_word(word1, word2)
581       break if word3 == MARKER
582       output << word3
583       word1, word2 = word2, word3
584     end
585     if output.length > 1
586       m.reply output.join(" ")
587     else
588       m.reply _("I can't :(")
589     end
590   end
591
592   def learn(*lines)
593     lines.each { |l| @learning_queue.push l }
594   end
595
596   def unreplied(m)
597     return if ignore? m
598
599     # in channel message, the kind we are interested in
600     message = m.plainmessage
601
602     if m.action?
603       message = "#{m.sourcenick} #{message}"
604     end
605
606     random_markov(m, message) unless readonly? m or m.replied?
607     learn clean_message(m)
608   end
609
610
611   def learn_triplet(word1, word2, word3)
612       k = "#{word1} #{word2}"
613       rk = "#{word2} #{word3}"
614       total = 0
615       hash = Hash.new(0)
616       if @chains.key? k
617         t2, h2 = @chains[k]
618         total += t2
619         hash.update h2
620       end
621       hash[word3] += 1
622       total += 1
623       @chains[k] = [total, hash]
624       # Reverse
625       total = 0
626       hash = Hash.new(0)
627       if @rchains.key? rk
628         t2, h2 = @rchains[rk]
629         total += t2
630         hash.update h2
631       end
632       hash[word1] += 1
633       total += 1
634       @rchains[rk] = [total, hash]
635   end
636
637
638   def learn_line(message)
639     # debug "learning #{message.inspect}"
640     wordlist = message.split(/\s+/).reject do |w|
641       @bot.config['markov.ignore_patterns'].map do |pat|
642         w =~ Regexp.new(pat.to_s)
643       end.select{|v| v}.size != 0
644     end
645     return unless wordlist.length >= 2
646     word1, word2 = MARKER, MARKER
647     wordlist << MARKER
648     wordlist.each do |word3|
649       learn_triplet(word1, word2, word3.to_sym)
650       word1, word2 = word2, word3
651     end
652   end
653
654   # TODO allow learning from URLs
655   def learn_from(m, params)
656     begin
657       path = params[:file]
658       file = File.open(path, "r")
659       pattern = params[:pattern].empty? ? nil : Regexp.new(params[:pattern].to_s)
660     rescue Errno::ENOENT
661       m.reply _("no such file")
662       return
663     end
664
665     if file.eof?
666       m.reply _("the file is empty!")
667       return
668     end
669
670     if params[:testing]
671       lines = []
672       range = case params[:lines]
673       when /^\d+\.\.\d+$/
674         Range.new(*params[:lines].split("..").map { |e| e.to_i })
675       when /^\d+$/
676         Range.new(1, params[:lines].to_i)
677       else
678         Range.new(1, [@bot.config['send.max_lines'], 3].max)
679       end
680
681       file.each do |line|
682         next unless file.lineno >= range.begin
683         lines << line.chomp
684         break if file.lineno == range.end
685       end
686
687       lines = lines.map do |l|
688         pattern ? l.scan(pattern).to_s : l
689       end.reject { |e| e.empty? }
690
691       if pattern
692         unless lines.empty?
693           m.reply _("example matches for that pattern at lines %{range} include: %{lines}") % {
694             :lines => lines.map { |e| Underline+e+Underline }.join(", "),
695             :range => range.to_s
696           }
697         else
698           m.reply _("the pattern doesn't match anything at lines %{range}") % {
699             :range => range.to_s
700           }
701         end
702       else
703         m.reply _("learning from the file without a pattern would learn, for example: ")
704         lines.each { |l| m.reply l }
705       end
706
707       return
708     end
709
710     if pattern
711       file.each { |l| learn(l.scan(pattern).to_s) }
712     else
713       file.each { |l| learn(l.chomp) }
714     end
715
716     m.okay
717   end
718
719   def stats(m, params)
720     m.reply "Markov status: chains: #{@chains.length} forward, #{@rchains.length} reverse, queued phrases: #{@learning_queue.size}"
721   end
722
723 end
724
725 plugin = MarkovPlugin.new
726 plugin.map 'markov delay :delay', :action => "set_delay"
727 plugin.map 'markov delay', :action => "set_delay"
728 plugin.map 'markov ignore :action :option', :action => "ignore"
729 plugin.map 'markov ignore :action', :action => "ignore"
730 plugin.map 'markov ignore', :action => "ignore"
731 plugin.map 'markov readonly :action :option', :action => "readonly"
732 plugin.map 'markov readonly :action', :action => "readonly"
733 plugin.map 'markov readonly', :action => "readonly"
734 plugin.map 'markov enable', :action => "enable"
735 plugin.map 'markov disable', :action => "disable"
736 plugin.map 'markov status', :action => "status"
737 plugin.map 'markov stats', :action => "stats"
738 plugin.map 'chat about :seed1 [:seed2]', :action => "chat"
739 plugin.map 'chat', :action => "rand_chat"
740 plugin.map 'markov probability [:probability]', :action => "probability",
741            :requirements => {:probability => /^\d+%?$/}
742 plugin.map 'markov learn from :file [:testing [:lines lines]] [using pattern *pattern]', :action => "learn_from", :thread => true,
743            :requirements => {
744              :testing => /^testing$/,
745              :lines   => /^(?:\d+\.\.\d+|\d+)$/ }
746
747 plugin.default_auth('ignore', false)
748 plugin.default_auth('probability', false)
749 plugin.default_auth('learn', false)
750