rbot 0.9.10 → 0.9.12

data/data/rbot/plugins/bash.rb

@@ -1,36 +1,174 @@
-# bash.org xml plugin for rbot
-# by Robin Kearney (robin@riviera.org.uk)
+#-- vim:sw=2:et
+#++
 #
-# its a bit of a quick hack, but it works for us :)
+# :title: bash.org quote retrieval
 #
+# Author:: Robin Kearney <robin@riviera.org.uk>
+# Author:: cs
+# Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
+#
+# Copyright:: (C) 2005 Robin Kearney
+# Copyright:: (C) 2007 cs, Giuseppe Bilotta
+#
+# License:: public domain
+#
+# TODO improve output of quote
+# TODO show more than one quote
+# TODO allow selection of only quotes with vote > 0
+
 require 'rexml/document'
-require 'uri/common'
+
+class ::BashQuote
+  attr_accessor :num, :text, :irc_text, :vote
+
+  def initialize(num, text, vote)
+    @num = num.to_i
+    @text = text
+    @vote = vote
+    @irc_text = mk_irc_text
+  end
+
+  def url
+    "http://www.bash.org/?#{@num}"
+  end
+
+  def to_s
+    "#%d (%d): %s" % [self.num, self.vote, self.irc_text]
+  end
+
+  private
+  def mk_irc_text
+    cur_nick = nil
+    last_nick = nil
+    text = String.new
+    @text.each_line { |l|
+      debug "line: #{l.inspect}"
+      cur_nick = l.match(/^\s*(&lt;.*?&gt;|\(.*?\)|.*?:)\s/)[1] rescue nil
+      debug "nick: #{cur_nick.inspect}; last: #{last_nick.inspect}"
+      if cur_nick and cur_nick == last_nick
+        text << l.sub(cur_nick,"")
+      else
+        last_nick = cur_nick.dup if cur_nick
+        text << l
+      end
+    }
+    debug text
+    # TODO: the gsub of br tags to | should be an ircify_html option
+    text.gsub(/(?:<br \/>\s*)+/, ' | ').ircify_html
+  end
+
+end
 
 class BashPlugin < Plugin
+
+  Config.register Config::EnumValue.new('bash.access',
+    :values => ['xml', 'html'], :default => 'html',
+    :desc => "Which method the bot should use to access bash.org quotes: xml files or standard webpages")
+
   include REXML
   def help(plugin, topic="")
     "bash => print a random quote from bash.org, bash quote_id => print that quote id from bash.org, bash latest => print the latest quote from bash.org (currently broken, need to get josh@bash.org to fix the xml)"
   end
-  def privmsg(m)
-    if m.params && m.params =~ /^([-\d]+)$/
-      id = $1
-      bash m, id
-	elsif(m.params == "latest")
-	  bash m, id
+
+  def bash_filter(s)
+    # check if we like the location of the page
+    loc = Utils.check_location(s, %r{http://(?:www\.)?bash\.org/\?})
+    return unless loc
+    # check if there are any quotes
+    quotes = get_html_quotes(s[:text])
+    return if quotes.empty?
+    title = s[:text].ircify_html_title
+    # return the first quote
+    return {
+          :title => title,
+          :content => quotes.first.to_s,
+          :bash_quotes => quotes
+    }
+  end
+
+  def initialize
+    super
+
+    @bot.register_filter(:bash, :htmlinfo) { |s| bash_filter(s) }
+  end
+
+  def bash(m, params)
+    id = params[:id]
+    case @bot.config['bash.access'].intern
+    when :xml
+      xml_bash(m, id)
+    else
+      html_bash(m, :id => id)
+    end
+  end
+
+  def search(m, params)
+    esc = CGI.escape(params[:words].to_s)
+    html = @bot.httputil.get("http://bash.org/?search=#{esc}")
+    html_bash(m, :html => html)
+  end
+
+  def get_html_quotes(html)
+    quotes = []
+
+    html_quotes = html.split(/<p class="quote">/)
+    html_quotes.each { |htqt|
+      # debug htqt.inspect
+      if htqt.match(/<a href="\?(\d+)"[^>]*>.*?\((-?\d+)\).*?<p class="qt">(.*)<\/p>\s+(?:<\/td>.*)?\z/m)
+        num = $1
+        vote = $2
+        text = $3
+        quotes << BashQuote.new(num, text, vote)
+      end
+    }
+    return quotes
+  end
+
+  def html_bash(m, opts={})
+    html = opts[:html]
+    if not html
+      id = opts[:id]
+      case id
+      when 'latest'
+        html = @bot.httputil.get("http://bash.org/?latest")
+      when nil
+        html = @bot.httputil.get("http://bash.org/?random", :cache => false)
+      else
+        html = @bot.httputil.get("http://bash.org/?" + id)
+      end
+    end
+
+    if not html
+      m.reply "unable to retrieve quotes"
+      return
+    end
+
+    quotes = get_html_quotes(html)
+
+    case quotes.length
+    when 0
+      m.reply "no quotes found"
+      return
+    when 1
+      quote = quotes.first
     else
-      bash m
+      # For the time being, we only echo the first quote, but in the future we
+      # may want to echo more than one for latest/random
+      quote = quotes.first
     end
+    m.reply quote.to_s
   end
-  
-  def bash(m, id=0)
 
-	if(id != 0)
-    	xml = @bot.httputil.get URI.parse("http://bash.org/xml/?" + id + "&num=1")
-	elsif(id == "latest")
-    	xml = @bot.httputil.get URI.parse("http://bash.org/xml/?latest&num=1")
-	else
-    	xml = @bot.httputil.get URI.parse("http://bash.org/xml/?random&num=1")
-	end	
+  def xml_bash(m, id=nil)
+    case id
+    when 'latest'
+      xml = @bot.httputil.get("http://bash.org/xml/?latest&num=1")
+    when nil
+      xml = @bot.httputil.get("http://bash.org/xml/?random&num=1", :cache => false)
+    else
+      xml = @bot.httputil.get("http://bash.org/xml/?" + id + "&num=1")
+    end	
+
     unless xml
       m.reply "bash.org rss parse failed"
       return
@@ -40,17 +178,21 @@ class BashPlugin < Plugin
       m.reply "bash.org rss parse failed"
       return
     end
-	doc.elements.each("*/item") {|e|
-		if(id != 0) 
-			reply = e.elements["title"].text.gsub(/QDB: /,"") + " " + e.elements["link"].text.gsub(/QDB: /,"") + "\n"
-			reply = reply + e.elements["description"].text.gsub(/\<br \/\>/, "\n")
-		else
-			reply = e.elements["title"].text.gsub(/QDB: /,"") + " " + e.elements["link"].text.gsub(/QDB: /,"") + "\n"
-			reply = reply + e.elements["description"].text.gsub(/\<br \/\>/, "\n")
-		end
-		m.reply reply
-	}
+    doc.elements.each("*/item") {|e|
+      if(id != 0) 
+        reply = e.elements["title"].text.gsub(/QDB: /,"") + " " + e.elements["link"].text.gsub(/QDB: /,"") + "\n"
+        reply = reply + e.elements["description"].text.gsub(/\<br \/\>/, "\n")
+      else
+        reply = e.elements["title"].text.gsub(/QDB: /,"") + " " + e.elements["link"].text.gsub(/QDB: /,"") + "\n"
+        reply = reply + e.elements["description"].text.gsub(/\<br \/\>/, "\n")
+      end
+      m.reply reply
+    }
   end
 end
+
 plugin = BashPlugin.new
-plugin.register("bash")
+
+plugin.map "bash search *words", :action => :search
+plugin.map "bash [:id]"
+

data/data/rbot/plugins/botsnack.rb

@@ -0,0 +1,37 @@
+#-- vim:sw=2:et
+#++
+#
+# :title: botsnack - give your bot some love
+# :version: 1.0a
+#
+# Author:: Jan Wikholm <jw@jw.fi>
+#
+# Copyright:: (C) 2008 Jan Wikholm
+#
+# License:: public domain
+#
+# TODO More replies
+
+
+
+
+class BotsnackPlugin < Plugin
+
+  def help(plugin, topic="")
+    "botsnack => reward #{@bot.nick} for being good"
+  end
+
+
+  def snack(m, params)
+    if m.public?
+      m.reply @bot.lang.get("thanks_X") % m.sourcenick
+    else
+      m.reply @bot.lang.get("thanks")
+    end
+  end
+end
+
+plugin = BotsnackPlugin.new
+
+plugin.map "botsnack", :action => :snack, :thread => "yes" #so it won't lock
+

data/data/rbot/plugins/cal.rb

@@ -1,12 +1,21 @@
 class CalPlugin < Plugin
+  Config.register Config::StringValue.new('cal.path',
+     :default => 'cal',
+     :desc => _('Path to the cal program'))
+
   def help(plugin, topic="")
     "cal [month year] => show current calendar [optionally specify month and year]"
   end
+  
+  def cal_path
+    @bot.config["cal.path"]
+  end
+
   def cal(m, params)
     if params.has_key?(:month)
-      m.reply Utils.safe_exec("cal", params[:month], params[:year])
+      m.reply Utils.safe_exec(cal_path, params[:month], params[:year])
     else
-      m.reply Utils.safe_exec("cal")
+      m.reply Utils.safe_exec(cal_path)
     end
   end
 end

data/data/rbot/plugins/chanserv.rb

@@ -0,0 +1,132 @@
+#-- vim:sw=2:et
+#++
+#
+# :title: Chanserv management plugin for rbot
+#
+# Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
+#
+# Copyright:: (C) 2006-2007 Giuseppe Bilotta
+#
+# ChanServ interface functionality.
+#
+# Currently, it only uses Chanserv to automatically op/hop/voice itself or others on channels where it can.
+#
+# TODO:: improve documentation, it really sucks as of now
+
+class ChanServPlugin < Plugin
+
+  Config.register Config::StringValue.new('chanserv.name',
+    :default => "chanserv", :requires_restart => false,
+    :desc => "Name of the chan server (all lowercase)")
+
+  def help(plugin, topic="")
+    case topic
+    when ""
+      return "chanserv plugin: interface the bot with the chanserv; topics: add, rm, list"
+    when "add"
+      return "chanserv add +status+ +channel+ [+nick+] => the bot will tell chanserv to set the status of +nick+ on +channel+ to +status+"
+    when "rm"
+      return "chanserv rm +status+ +channel+ [+nick+] => the bot will not tell chanserv to set the status of +nick+ on +channel+ to +status+ anymore"
+    when "list"
+      return "chanserv list => list current chanserv status modifiers"
+    end
+  end
+
+  # Returns the chanserv name
+  def cs_nick
+    @bot.config['chanserv.name']
+  end
+
+  # say something to chanserv
+  def cs_say(msg)
+    @bot.say cs_nick, msg
+  end
+
+  def cs_add(m, params)
+    status = params[:status].downcase
+    ch = params[:channel].downcase
+    who = params[:nick].downcase rescue ''
+    as = @registry[:auto_status] || Array.new
+    as << [status, ch, who]
+    debug as.inspect
+    @registry[:auto_status] = as
+    m.okay
+  end
+
+  def cs_rm(m, params)
+    status = params[:status].downcase
+    ch = params[:channel].downcase
+    who = params[:nick].downcase rescue ''
+    as = @registry[:auto_status]
+    unless as
+      m.reply "No chanserv entries known!"
+      return
+    end
+    as.delete [status, ch, who]
+    debug as.inspect
+    @registry[:auto_status] = as
+    m.okay
+  end
+
+  def cs_list(m, params)
+    unless @registry[:auto_status]
+      m.reply "No chanserv entries known!"
+      return
+    end
+    @registry[:auto_status].each { |status, ch, pre_who|
+      who = pre_who.empty? ? "me (yes, me)" : pre_who
+      m.reply "chanserv should #{status} #{who} on #{ch}"
+    }
+
+  end
+
+  def join(m)
+    return unless @registry[:auto_status]
+    @registry[:auto_status].each { |status, ch, pre_who|
+      who = pre_who.empty? ? @bot.nick : pre_who
+      if m.channel.downcase == ch.downcase
+        if who.downcase == m.source.downcase
+          cs_say "#{status} #{ch} #{who}"
+        end
+      end
+    }
+  end
+
+  def nick(m)
+    return unless @registry[:auto_status]
+    is_on = m.server.channels.inject(ChannelList.new) { |list, ch|
+      list << ch if ch.users.include?(m.source)
+      list
+    }
+    is_on.each { |channel|
+      @registry[:auto_status].each { |status, ch, pre_who|
+        who = pre_who.empty? ? @bot.nick : pre_who
+        if channel.downcase == ch.downcase
+          if who.downcase == m.source.downcase
+            cs_say "#{status} #{ch} #{who}"
+          end
+        end
+      }
+    }
+  end
+
+  # This method gets delegated by the NickServ plugin after successfull identification
+  def identified
+    return unless @registry[:auto_status]
+    @registry[:auto_status].each { |status, ch, who|
+      if who.empty?
+        cs_say "#{status} #{ch} #{@bot.nick}"
+      end
+    }
+  end
+
+
+end
+
+plugin = ChanServPlugin.new
+plugin.map 'chanserv add :status :channel [:nick]', :action => :cs_add
+plugin.map 'chanserv rm :status :channel [:nick]', :action => :cs_rm
+plugin.map 'chanserv list', :action => :cs_list
+
+plugin.default_auth('*', false)
+

data/data/rbot/plugins/chucknorris.rb

@@ -43,7 +43,7 @@ class ChuckNorrisPlugin < Plugin
   
   # HELP!
   def help(plugin, topic="chuck")
-    "fact|chuck|norris|chucknorris [min_rating] => \"fact\" shows a random Chuck Norris fact (optional minimum rating from 1-10, default=6.0)."
+    "chuck|norris|chucknorris [min_rating] => show a random Chuck Norris fact (optional minimum rating from 1-10, default=6.0)."
     #\"fact [person]\" shows a fact about someone in the channel. 
   end
 
@@ -67,7 +67,7 @@ end
 
 plugin = ChuckNorrisPlugin.new
 
-plugin.map 'fact :minrating', :action => 'fact', :defaults => {:minrating=>MIN_RATING}
+# plugin.map 'fact :minrating', :action => 'fact', :defaults => {:minrating=>MIN_RATING}
 plugin.map 'chucknorris :minrating', :action => 'fact', :defaults => {:minrating=>MIN_RATING}
 plugin.map 'chuck :minrating', :action => 'fact', :defaults => {:minrating=>MIN_RATING}
 plugin.map 'norris :minrating', :action => 'fact', :defaults => {:minrating=>MIN_RATING}

data/data/rbot/plugins/debugger.rb

@@ -0,0 +1,136 @@
+#-- vim:sw=2:et
+#++
+#
+# :title: Debugging/profiling for rbot
+#
+# Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
+# Copyright:: (C) 2006-2007 Giuseppe Bilotta
+# License:: GPL v2
+
+class DebugPlugin < Plugin
+  Config.register Config::IntegerValue.new('debug.interval',
+    :default => 10, :validate => Proc.new{|v| v > 0},
+    :desc => "Number of seconds between memory profile dumps")
+  Config.register Config::BooleanValue.new('debug.dump_strings',
+    :default => false,
+    :desc => "Set to true if you want the profiler to dump strings, false otherwise")
+  Config.register Config::StringValue.new('debug.logdir',
+    :default => "",
+    :desc => "Directory where profile/string dumps are to be stored")
+
+  def initialize
+    super
+    @prev = Hash.new(0)
+    @curr = Hash.new(0)
+    @delta = Hash.new(0)
+    @file = File.open("#{@bot.botclass}/#{@bot.config['debug.logdir']}/memory_profiler.log",'w')
+    @thread = @bot.timer.add(@bot.config['debug.interval']) {
+        begin
+          GC.start
+          @curr.clear
+
+          curr_strings = []
+
+          ObjectSpace.each_object do |o|
+            @curr[o.class] += 1 #Marshal.dump(o).size rescue 1
+            if @bot.config['debug.dump_strings'] and o.class == String
+              curr_strings.push o
+            end
+          end
+
+          if @bot.config['debug.dump_strings']
+            File.open("#{@bot.botclass}/#{@bot.config['debug.logdir']}/memory_profiler_strings.log.#{Time.now.to_i}",'w') do |f|
+              curr_strings.sort.each do |s|
+                f.puts s
+              end
+            end
+            curr_strings.clear
+          end
+
+          @delta.clear
+          (@curr.keys + @prev.keys).uniq.each do |k,v|
+            @delta[k] = @curr[k]-@prev[k]
+          end
+
+          @file.puts "Top 20"
+          @delta.sort_by { |k,v| -v.abs }[0..19].sort_by { |k,v| -v}.each do |k,v|
+            @file.printf "%+5d: %s (%d)\n", v, k.name, @curr[k] unless v == 0
+          end
+          @file.flush
+
+          @delta.clear
+          @prev.clear
+          @prev.update @curr
+          GC.start
+        rescue Exception => err
+          error "** memory_profiler error: #{err}"
+        end
+    }
+    @bot.timer.block(@thread)
+  end
+
+  def help( plugin, topic="" )
+      "debug start => start the periodic profiler; " + \
+      "debug stop => stops the periodic profiler; " + \
+      "debug dumpstrings => dump all of the strings"
+  end
+
+  def start_it(m, params)
+    begin
+      @bot.timer.unblock(@thread)
+      m.reply "profile dump started"
+    rescue Exception => err
+      m.reply "couldn't start profile dump"
+      error "couldn't start profile dump: #{err}"
+    end
+  end
+
+  def stop_it(m, params)
+    begin
+      @bot.timer.block(@thread)
+      m.reply "profile dump stop"
+    rescue Exception => err
+      m.reply "couldn't stop profile dump"
+      error "couldn't stop profile dump: #{err}"
+    end
+  end
+
+  def dump_strings(m, params)
+    curr_strings = []
+
+    m.reply "Dumping strings ..."
+    begin
+      GC.start
+      ObjectSpace.each_object do |o|
+        if o.class == String
+          curr_strings.push o
+        end
+      end
+
+      File.open("#{@bot.botclass}/#{@bot.config['debug.logdir']}/memory_profiler_strings.log.#{Time.now.to_i}",'w') do |f|
+        curr_strings.sort.each do |s|
+          f.puts s
+        end
+      end
+      GC.start
+      m.reply "... done"
+    rescue Exception => err
+      m.reply "dumping strings failed"
+      error "dumping strings failed: #{err}"
+    end
+  end
+
+end
+
+
+plugin = DebugPlugin.new
+
+plugin.default_auth( 'start', false )
+plugin.default_auth( 'stop', false )
+plugin.default_auth( 'dumpstrings', false )
+
+plugin.map 'debug start', :action => 'start_it'
+plugin.map 'debug stop', :action => 'stop_it'
+plugin.map 'debug dumpstrings', :action => 'dump_strings'
+
+