rbot 0.9.9

data/lib/rbot/httputil.rb

@@ -0,0 +1,141 @@
+module Irc
+module Utils
+
+require 'resolv'
+require 'net/http'
+Net::HTTP.version_1_2
+  
+# class for making http requests easier (mainly for plugins to use)
+# this class can check the bot proxy configuration to determine if a proxy
+# needs to be used, which includes support for per-url proxy configuration.
+class HttpUtil
+    BotConfig.register BotConfigBooleanValue.new('http.use_proxy',
+      :default => false, :desc => "should a proxy be used for HTTP requests?")
+    BotConfig.register BotConfigStringValue.new('http.proxy_uri', :default => false,
+      :desc => "Proxy server to use for HTTP requests (URI, e.g http://proxy.host:port)")
+    BotConfig.register BotConfigStringValue.new('http.proxy_user',
+      :default => nil,
+      :desc => "User for authenticating with the http proxy (if required)")
+    BotConfig.register BotConfigStringValue.new('http.proxy_pass',
+      :default => nil,
+      :desc => "Password for authenticating with the http proxy (if required)")
+    BotConfig.register BotConfigArrayValue.new('http.proxy_include',
+      :default => [],
+      :desc => "List of regexps to check against a URI's hostname/ip to see if we should use the proxy to access this URI. All URIs are proxied by default if the proxy is set, so this is only required to re-include URIs that might have been excluded by the exclude list. e.g. exclude /.*\.foo\.com/, include bar\.foo\.com")
+    BotConfig.register BotConfigArrayValue.new('http.proxy_exclude',
+      :default => [],
+      :desc => "List of regexps to check against a URI's hostname/ip to see if we should use avoid the proxy to access this URI and access it directly")
+
+  def initialize(bot)
+    @bot = bot
+    @headers = {
+      'User-Agent' => "rbot http util #{$version} (http://linuxbrit.co.uk/rbot/)",
+    }
+  end
+
+  # if http_proxy_include or http_proxy_exclude are set, then examine the
+  # uri to see if this is a proxied uri
+  # the in/excludes are a list of regexps, and each regexp is checked against
+  # the server name, and its IP addresses
+  def proxy_required(uri)
+    use_proxy = true
+    if @bot.config["http.proxy_exclude"].empty? && @bot.config["http.proxy_include"].empty?
+      return use_proxy
+    end
+
+    list = [uri.host]
+    begin
+      list.concat Resolv.getaddresses(uri.host)
+    rescue StandardError => err
+      puts "warning: couldn't resolve host uri.host"
+    end
+
+    unless @bot.config["http.proxy_exclude"].empty?
+      re = @bot.config["http.proxy_exclude"].collect{|r| Regexp.new(r)}
+      re.each do |r|
+        list.each do |item|
+          if r.match(item)
+            use_proxy = false
+            break
+          end
+        end
+      end
+    end
+    unless @bot.config["http.proxy_include"].empty?
+      re = @bot.config["http.proxy_include"].collect{|r| Regexp.new(r)}
+      re.each do |r|
+        list.each do |item|
+          if r.match(item)
+            use_proxy = true
+            break
+          end
+        end
+      end
+    end
+    debug "using proxy for uri #{uri}?: #{use_proxy}"
+    return use_proxy
+  end
+
+  # uri:: Uri to create a proxy for
+  #
+  # return a net/http Proxy object, which is configured correctly for
+  # proxying based on the bot's proxy configuration. 
+  # This will include per-url proxy configuration based on the bot config
+  # +http_proxy_include/exclude+ options.
+  def get_proxy(uri)
+    proxy = nil
+    proxy_host = nil
+    proxy_port = nil
+    proxy_user = nil
+    proxy_pass = nil
+
+    if @bot.config["http.use_proxy"]
+      if (ENV['http_proxy'])
+        proxy = URI.parse ENV['http_proxy'] rescue nil
+      end
+      if (@bot.config["http.proxy_uri"])
+        proxy = URI.parse @bot.config["http.proxy_uri"] rescue nil
+      end
+      if proxy
+        debug "proxy is set to #{proxy.uri}"
+        if proxy_required(uri)
+          proxy_host = proxy.host
+          proxy_port = proxy.port
+          proxy_user = @bot.config["http.proxy_user"]
+          proxy_pass = @bot.config["http.proxy_pass"]
+        end
+      end
+    end
+    
+    return Net::HTTP.new(uri.host, uri.port, proxy_host, proxy_port, proxy_user, proxy_port)
+  end
+
+  # uri::         uri to query (Uri object)
+  # readtimeout:: timeout for reading the response
+  # opentimeout:: timeout for opening the connection
+  #
+  # simple get request, returns response body if the status code is 200 and
+  # the request doesn't timeout.
+  def get(uri, readtimeout=10, opentimeout=5)
+    proxy = get_proxy(uri)
+    proxy.open_timeout = opentimeout
+    proxy.read_timeout = readtimeout
+   
+    begin
+      proxy.start() {|http|
+        resp = http.get(uri.request_uri(), @headers)
+        if resp.code == "200"
+          return resp.body
+        else
+          puts "HttpUtil.get return code #{resp.code} #{resp.body}"
+        end
+        return nil
+      }
+    rescue StandardError, Timeout::Error => e
+      $stderr.puts "HttpUtil.get exception: #{e}, while trying to get #{uri}"
+    end
+    return nil
+  end
+end
+end
+end

data/lib/rbot/ircbot.rb

@@ -0,0 +1,808 @@
+require 'thread'
+require 'etc'
+require 'fileutils'
+
+$debug = false unless $debug
+# print +message+ if debugging is enabled
+def debug(message=nil)
+  print "DEBUG: #{message}\n" if($debug && message)
+  #yield
+end
+
+# these first
+require 'rbot/rbotconfig'
+require 'rbot/config'
+require 'rbot/utils'
+
+require 'rbot/rfc2812'
+require 'rbot/keywords'
+require 'rbot/ircsocket'
+require 'rbot/auth'
+require 'rbot/timer'
+require 'rbot/plugins'
+require 'rbot/channel'
+require 'rbot/message'
+require 'rbot/language'
+require 'rbot/dbhash'
+require 'rbot/registry'
+require 'rbot/httputil'
+
+module Irc
+
+# Main bot class, which manages the various components, receives messages,
+# handles them or passes them to plugins, and contains core functionality.
+class IrcBot
+  # the bot's current nickname
+  attr_reader :nick
+  
+  # the bot's IrcAuth data
+  attr_reader :auth
+  
+  # the bot's BotConfig data
+  attr_reader :config
+  
+  # the botclass for this bot (determines configdir among other things)
+  attr_reader :botclass
+  
+  # used to perform actions periodically (saves configuration once per minute
+  # by default)
+  attr_reader :timer
+  
+  # bot's Language data
+  attr_reader :lang
+
+  # bot's configured addressing prefixes
+  attr_reader :addressing_prefixes
+
+  # channel info for channels the bot is in
+  attr_reader :channels
+
+  # bot's irc socket
+  attr_reader :socket
+
+  # bot's object registry, plugins get an interface to this for persistant
+  # storage (hash interface tied to a bdb file, plugins use Accessors to store
+  # and restore objects in their own namespaces.)
+  attr_reader :registry
+
+  # bot's httputil help object, for fetching resources via http. Sets up
+  # proxies etc as defined by the bot configuration/environment
+  attr_reader :httputil
+
+  # create a new IrcBot with botclass +botclass+
+  def initialize(botclass, params = {})
+    # BotConfig for the core bot
+    BotConfig.register BotConfigStringValue.new('server.name',
+      :default => "localhost", :requires_restart => true,
+      :desc => "What server should the bot connect to?",
+      :wizard => true)
+    BotConfig.register BotConfigIntegerValue.new('server.port',
+      :default => 6667, :type => :integer, :requires_restart => true,
+      :desc => "What port should the bot connect to?", 
+      :validate => Proc.new {|v| v > 0}, :wizard => true)
+    BotConfig.register BotConfigStringValue.new('server.password',
+      :default => false, :requires_restart => true,
+      :desc => "Password for connecting to this server (if required)",
+      :wizard => true)
+    BotConfig.register BotConfigStringValue.new('server.bindhost',
+      :default => false, :requires_restart => true,
+      :desc => "Specific local host or IP for the bot to bind to (if required)",
+      :wizard => true)
+    BotConfig.register BotConfigIntegerValue.new('server.reconnect_wait',
+      :default => 5, :validate => Proc.new{|v| v >= 0},
+      :desc => "Seconds to wait before attempting to reconnect, on disconnect")
+    BotConfig.register BotConfigStringValue.new('irc.nick', :default => "rbot",
+      :desc => "IRC nickname the bot should attempt to use", :wizard => true,
+      :on_change => Proc.new{|bot, v| bot.sendq "NICK #{v}" })
+    BotConfig.register BotConfigStringValue.new('irc.user', :default => "rbot",
+      :requires_restart => true,
+      :desc => "local user the bot should appear to be", :wizard => true)
+    BotConfig.register BotConfigArrayValue.new('irc.join_channels',
+      :default => [], :wizard => true,
+      :desc => "What channels the bot should always join at startup. List multiple channels using commas to separate. If a channel requires a password, use a space after the channel name. e.g: '#chan1, #chan2, #secretchan secritpass, #chan3'")
+    BotConfig.register BotConfigIntegerValue.new('core.save_every',
+      :default => 60, :validate => Proc.new{|v| v >= 0},
+      # TODO change timer via on_change proc
+      :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example")
+    BotConfig.register BotConfigFloatValue.new('server.sendq_delay',
+      :default => 2.0, :validate => Proc.new{|v| v >= 0},
+      :desc => "(flood prevention) the delay between sending messages to the server (in seconds)",
+      :on_change => Proc.new {|bot, v| bot.socket.sendq_delay = v })
+    BotConfig.register BotConfigIntegerValue.new('server.sendq_burst',
+      :default => 4, :validate => Proc.new{|v| v >= 0},
+      :desc => "(flood prevention) max lines to burst to the server before throttling. Most ircd's allow bursts of up 5 lines, with non-burst limits of 512 bytes/2 seconds",
+      :on_change => Proc.new {|bot, v| bot.socket.sendq_burst = v })
+
+    @argv = params[:argv]
+
+    unless FileTest.directory? Config::datadir
+      puts "data directory '#{Config::datadir}' not found, did you install.rb?"
+      exit 2
+    end
+    
+    botclass = "/home/#{Etc.getlogin}/.rbot" unless botclass
+    @botclass = botclass.gsub(/\/$/, "")
+
+    unless FileTest.directory? botclass
+      puts "no #{botclass} directory found, creating from templates.."
+      if FileTest.exist? botclass
+        puts "Error: file #{botclass} exists but isn't a directory"
+        exit 2
+      end
+      FileUtils.cp_r Config::datadir+'/templates', botclass
+    end
+    
+    Dir.mkdir("#{botclass}/logs") unless File.exist?("#{botclass}/logs")
+
+    @startup_time = Time.new
+    @config = BotConfig.new(self)
+    @timer = Timer::Timer.new(1.0) # only need per-second granularity
+    @registry = BotRegistry.new self
+    @timer.add(@config['core.save_every']) { save } if @config['core.save_every']
+    @channels = Hash.new
+    @logs = Hash.new
+    
+    @httputil = Utils::HttpUtil.new(self)
+    @lang = Language::Language.new(@config['core.language'])
+    @keywords = Keywords.new(self)
+    @auth = IrcAuth.new(self)
+
+    Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
+    @plugins = Plugins::Plugins.new(self, ["#{botclass}/plugins"])
+
+    @socket = IrcSocket.new(@config['server.name'], @config['server.port'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'])
+    @nick = @config['irc.nick']
+    if @config['core.address_prefix']
+      @addressing_prefixes = @config['core.address_prefix'].split(" ")
+    else
+      @addressing_prefixes = Array.new
+    end
+    
+    @client = IrcClient.new
+    @client[:privmsg] = proc { |data|
+      message = PrivMessage.new(self, data[:source], data[:target], data[:message])
+      onprivmsg(message)
+    }
+    @client[:notice] = proc { |data|
+      message = NoticeMessage.new(self, data[:source], data[:target], data[:message])
+      # pass it off to plugins that want to hear everything
+      @plugins.delegate "listen", message
+    }
+    @client[:motd] = proc { |data|
+      data[:motd].each_line { |line|
+        log "MOTD: #{line}", "server"
+      }
+    }
+    @client[:nicktaken] = proc { |data| 
+      nickchg "#{data[:nick]}_"
+    }
+    @client[:badnick] = proc {|data| 
+      puts "WARNING, bad nick (#{data[:nick]})"
+    }
+    @client[:ping] = proc {|data|
+      # (jump the queue for pongs)
+      @socket.puts "PONG #{data[:pingid]}"
+    }
+    @client[:nick] = proc {|data|
+      sourcenick = data[:sourcenick]
+      nick = data[:nick]
+      m = NickMessage.new(self, data[:source], data[:sourcenick], data[:nick])
+      if(sourcenick == @nick)
+        debug "my nick is now #{nick}"
+        @nick = nick
+      end
+      @channels.each {|k,v|
+        if(v.users.has_key?(sourcenick))
+          log "@ #{sourcenick} is now known as #{nick}", k
+          v.users[nick] = v.users[sourcenick]
+          v.users.delete(sourcenick)
+        end
+      }
+      @plugins.delegate("listen", m)
+      @plugins.delegate("nick", m)
+    }
+    @client[:quit] = proc {|data|
+      source = data[:source]
+      sourcenick = data[:sourcenick]
+      sourceurl = data[:sourceaddress]
+      message = data[:message]
+      m = QuitMessage.new(self, data[:source], data[:sourcenick], data[:message])
+      if(data[:sourcenick] =~ /#{@nick}/i)
+      else
+        @channels.each {|k,v|
+          if(v.users.has_key?(sourcenick))
+            log "@ Quit: #{sourcenick}: #{message}", k
+            v.users.delete(sourcenick)
+          end
+        }
+      end
+      @plugins.delegate("listen", m)
+      @plugins.delegate("quit", m)
+    }
+    @client[:mode] = proc {|data|
+      source = data[:source]
+      sourcenick = data[:sourcenick]
+      sourceurl = data[:sourceaddress]
+      channel = data[:channel]
+      targets = data[:targets]
+      modestring = data[:modestring]
+      log "@ Mode #{modestring} #{targets} by #{sourcenick}", channel
+    }
+    @client[:welcome] = proc {|data|
+      log "joined server #{data[:source]} as #{data[:nick]}", "server"
+      debug "I think my nick is #{@nick}, server thinks #{data[:nick]}"
+      if data[:nick] && data[:nick].length > 0
+        @nick = data[:nick]
+      end
+
+      @plugins.delegate("connect")
+
+      @config['irc.join_channels'].each {|c|
+        debug "autojoining channel #{c}"
+        if(c =~ /^(\S+)\s+(\S+)$/i)
+          join $1, $2
+        else
+          join c if(c)
+        end
+      }
+    }
+    @client[:join] = proc {|data|
+      m = JoinMessage.new(self, data[:source], data[:channel], data[:message])
+      onjoin(m)
+    }
+    @client[:part] = proc {|data|
+      m = PartMessage.new(self, data[:source], data[:channel], data[:message])
+      onpart(m)
+    }
+    @client[:kick] = proc {|data|
+      m = KickMessage.new(self, data[:source], data[:target],data[:channel],data[:message]) 
+      onkick(m)
+    }
+    @client[:invite] = proc {|data|
+      if(data[:target] =~ /^#{@nick}$/i)
+        join data[:channel] if (@auth.allow?("join", data[:source], data[:sourcenick]))
+      end
+    }
+    @client[:changetopic] = proc {|data|
+      channel = data[:channel]
+      sourcenick = data[:sourcenick]
+      topic = data[:topic]
+      timestamp = data[:unixtime] || Time.now.to_i
+      if(sourcenick == @nick)
+        log "@ I set topic \"#{topic}\"", channel
+      else
+        log "@ #{sourcenick} set topic \"#{topic}\"", channel
+      end
+      m = TopicMessage.new(self, data[:source], data[:channel], timestamp, data[:topic])
+
+      ontopic(m)
+      @plugins.delegate("listen", m)
+      @plugins.delegate("topic", m)
+    }
+    @client[:topic] = @client[:topicinfo] = proc {|data|
+      channel = data[:channel]
+      m = TopicMessage.new(self, data[:source], data[:channel], data[:unixtime], data[:topic])
+        ontopic(m)
+    }
+    @client[:names] = proc {|data|
+      channel = data[:channel]
+      users = data[:users]
+      unless(@channels[channel])
+        puts "bug: got names for channel '#{channel}' I didn't think I was in\n"
+        exit 2
+      end
+      @channels[channel].users.clear
+      users.each {|u|
+        @channels[channel].users[u[0].sub(/^[@&~+]/, '')] = ["mode", u[1]]
+      }
+    }
+    @client[:unknown] = proc {|data|
+      #debug "UNKNOWN: #{data[:serverstring]}"
+      log data[:serverstring], ":unknown"
+    }
+  end
+
+  # connect the bot to IRC
+  def connect
+    trap("SIGTERM") { quit }
+    trap("SIGHUP") { quit }
+    trap("SIGINT") { quit }
+    begin
+      @socket.connect
+      rescue => e
+      raise "failed to connect to IRC server at #{@config['server.name']} #{@config['server.port']}: " + e
+    end
+    @socket.puts "PASS " + @config['server.password'] if @config['server.password']
+    @socket.puts "NICK #{@nick}\nUSER #{@config['irc.user']} 4 #{@config['server.name']} :Ruby bot. (c) Tom Gilbert"
+  end
+
+  # begin event handling loop
+  def mainloop
+    while true
+      connect
+      @timer.start
+      
+      begin
+        while true
+          if @socket.select
+            break unless reply = @socket.gets
+            @client.process reply
+          end
+        end
+      rescue TimeoutError, SocketError => e
+        puts "network exception: connection closed: #{e}"
+        puts e.backtrace.join("\n")
+        @socket.close # now we reconnect
+      rescue => e # TODO be selective, only grab Network errors
+        puts "unexpected exception: connection closed: #{e}"
+        puts e.backtrace.join("\n")
+        exit 2
+      end
+      
+      puts "disconnected"
+      @channels.clear
+      @socket.clearq
+      
+      puts "waiting to reconnect"
+      sleep @config['server.reconnect_wait']
+    end
+  end
+  
+  # type:: message type
+  # where:: message target
+  # message:: message text
+  # send message +message+ of type +type+ to target +where+
+  # Type can be PRIVMSG, NOTICE, etc, but those you should really use the
+  # relevant say() or notice() methods. This one should be used for IRCd
+  # extensions you want to use in modules.
+  def sendmsg(type, where, message)
+    # limit it 440 chars + CRLF.. so we have to split long lines
+    left = 440 - type.length - where.length - 3
+    begin
+      if(left >= message.length)
+        sendq("#{type} #{where} :#{message}")
+        log_sent(type, where, message)
+        return
+      end
+      line = message.slice!(0, left)
+      lastspace = line.rindex(/\s+/)
+      if(lastspace)
+        message = line.slice!(lastspace, line.length) + message
+        message.gsub!(/^\s+/, "")
+      end
+      sendq("#{type} #{where} :#{line}")
+      log_sent(type, where, line)
+    end while(message.length > 0)
+  end
+
+  # queue an arbitraty message for the server
+  def sendq(message="")
+    # temporary
+    @socket.queue(message)
+  end
+
+  # send a notice message to channel/nick +where+
+  def notice(where, message)
+    message.each_line { |line|
+      line.chomp!
+      next unless(line.length > 0)
+      sendmsg("NOTICE", where, line)
+    }
+  end
+
+  # say something (PRIVMSG) to channel/nick +where+
+  def say(where, message)
+    message.to_s.gsub(/[\r\n]+/, "\n").each_line { |line|
+      line.chomp!
+      next unless(line.length > 0)
+      unless((where =~ /^#/) && (@channels.has_key?(where) && @channels[where].quiet))
+        sendmsg("PRIVMSG", where, line)
+      end
+    }
+  end
+
+  # perform a CTCP action with message +message+ to channel/nick +where+
+  def action(where, message)
+    sendq("PRIVMSG #{where} :\001ACTION #{message}\001")
+    if(where =~ /^#/)
+      log "* #{@nick} #{message}", where
+    elsif (where =~ /^(\S*)!.*$/)
+         log "* #{@nick}[#{where}] #{message}", $1
+    else
+         log "* #{@nick}[#{where}] #{message}", where
+    end
+  end
+
+  # quick way to say "okay" (or equivalent) to +where+
+  def okay(where)
+    say where, @lang.get("okay")
+  end
+
+  # log message +message+ to a file determined by +where+. +where+ can be a
+  # channel name, or a nick for private message logging
+  def log(message, where="server")
+    message.chomp!
+    stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S")
+    unless(@logs.has_key?(where))
+      @logs[where] = File.new("#{@botclass}/logs/#{where}", "a")
+      @logs[where].sync = true
+    end
+    @logs[where].puts "[#{stamp}] #{message}"
+    #debug "[#{stamp}] <#{where}> #{message}"
+  end
+  
+  # set topic of channel +where+ to +topic+
+  def topic(where, topic)
+    sendq "TOPIC #{where} :#{topic}"
+  end
+
+  # disconnect from the server and cleanup all plugins and modules
+  def shutdown(message = nil)
+    trap("SIGTERM", "DEFAULT")
+    trap("SIGHUP", "DEFAULT")
+    trap("SIGINT", "DEFAULT")
+    message = @lang.get("quit") if (message.nil? || message.empty?)
+    @socket.clearq
+    save
+    @plugins.cleanup
+    @channels.each_value {|v|
+      log "@ quit (#{message})", v.name
+    }
+    @socket.puts "QUIT :#{message}"
+    @socket.flush
+    @socket.shutdown
+    @registry.close
+    puts "rbot quit (#{message})"
+  end
+  
+  # message:: optional IRC quit message
+  # quit IRC, shutdown the bot
+  def quit(message=nil)
+    shutdown(message)
+    exit 0
+  end
+
+  # totally shutdown and respawn the bot
+  def restart
+    shutdown("restarting, back in #{@config['server.reconnect_wait']}...")
+    sleep @config['server.reconnect_wait']
+    # now we re-exec
+    exec($0, *@argv)
+  end
+
+  # call the save method for bot's config, keywords, auth and all plugins
+  def save
+    @registry.flush
+    @config.save
+    @keywords.save
+    @auth.save
+    @plugins.save
+  end
+
+  # call the rescan method for the bot's lang, keywords and all plugins
+  def rescan
+    @lang.rescan
+    @plugins.rescan
+    @keywords.rescan
+  end
+  
+  # channel:: channel to join
+  # key::     optional channel key if channel is +s
+  # join a channel
+  def join(channel, key=nil)
+    if(key)
+      sendq "JOIN #{channel} :#{key}"
+    else
+      sendq "JOIN #{channel}"
+    end
+  end
+
+  # part a channel
+  def part(channel, message="")
+    sendq "PART #{channel} :#{message}"
+  end
+
+  # attempt to change bot's nick to +name+
+  # FIXME
+  # if rbot is already taken, this happens:
+  #   <giblet> rbot_, nick rbot
+  #   --- rbot_ is now known as rbot__
+  # he should of course just keep his existing nick and report the error :P
+  def nickchg(name)
+      sendq "NICK #{name}"
+  end
+
+  # changing mode
+  def mode(channel, mode, target)
+      sendq "MODE #{channel} #{mode} #{target}"
+  end
+  
+  # m::     message asking for help
+  # topic:: optional topic help is requested for
+  # respond to online help requests
+  def help(topic=nil)
+    topic = nil if topic == ""
+    case topic
+    when nil
+      helpstr = "help topics: core, auth, keywords"
+      helpstr += @plugins.helptopics
+      helpstr += " (help <topic> for more info)"
+    when /^core$/i
+      helpstr = corehelp
+    when /^core\s+(.+)$/i
+      helpstr = corehelp $1
+    when /^auth$/i
+      helpstr = @auth.help
+    when /^auth\s+(.+)$/i
+      helpstr = @auth.help $1
+    when /^keywords$/i
+      helpstr = @keywords.help
+    when /^keywords\s+(.+)$/i
+      helpstr = @keywords.help $1
+    else
+      unless(helpstr = @plugins.help(topic))
+        helpstr = "no help for topic #{topic}"
+      end
+    end
+    return helpstr
+  end
+
+  # returns a string describing the current status of the bot (uptime etc)
+  def status
+    secs_up = Time.new - @startup_time
+    uptime = Utils.secs_to_string secs_up
+    return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@registry.length} items stored in registry, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
+  end
+
+
+  private
+
+  # handle help requests for "core" topics
+  def corehelp(topic="")
+    case topic
+      when "quit"
+        return "quit [<message>] => quit IRC with message <message>"
+      when "restart"
+        return "restart => completely stop and restart the bot (including reconnect)"
+      when "join"
+        return "join <channel> [<key>] => join channel <channel> with secret key <key> if specified. #{@nick} also responds to invites if you have the required access level"
+      when "part"
+        return "part <channel> => part channel <channel>"
+      when "hide"
+        return "hide => part all channels"
+      when "save"
+        return "save => save current dynamic data and configuration"
+      when "rescan"
+        return "rescan => reload modules and static facts"
+      when "nick"
+        return "nick <nick> => attempt to change nick to <nick>"
+      when "say"
+        return "say <channel>|<nick> <message> => say <message> to <channel> or in private message to <nick>"
+      when "action"
+        return "action <channel>|<nick> <message> => does a /me <message> to <channel> or in private message to <nick>"
+      when "topic"
+        return "topic <channel> <message> => set topic of <channel> to <message>"
+      when "quiet"
+        return "quiet [in here|<channel>] => with no arguments, stop speaking in all channels, if \"in here\", stop speaking in this channel, or stop speaking in <channel>"
+      when "talk"
+        return "talk [in here|<channel>] => with no arguments, resume speaking in all channels, if \"in here\", resume speaking in this channel, or resume speaking in <channel>"
+      when "version"
+        return "version => describes software version"
+      when "botsnack"
+        return "botsnack => reward #{@nick} for being good"
+      when "hello"
+        return "hello|hi|hey|yo [#{@nick}] => greet the bot"
+      else
+        return "Core help topics: quit, restart, config, join, part, hide, save, rescan, nick, say, action, topic, quiet, talk, version, botsnack, hello"
+    end
+  end
+
+  # handle incoming IRC PRIVMSG +m+
+  def onprivmsg(m)
+    # log it first
+    if(m.action?)
+      if(m.private?)
+        log "* [#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick
+      else
+        log "* #{m.sourcenick} #{m.message}", m.target
+      end
+    else
+      if(m.public?)
+        log "<#{m.sourcenick}> #{m.message}", m.target
+      else
+        log "[#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick
+      end
+    end
+
+    # pass it off to plugins that want to hear everything
+    @plugins.delegate "listen", m
+
+    if(m.private? && m.message =~ /^\001PING\s+(.+)\001/)
+      notice m.sourcenick, "\001PING #$1\001"
+      log "@ #{m.sourcenick} pinged me"
+      return
+    end
+
+    if(m.address?)
+      case m.message
+        when (/^join\s+(\S+)\s+(\S+)$/i)
+          join $1, $2 if(@auth.allow?("join", m.source, m.replyto))
+        when (/^join\s+(\S+)$/i)
+          join $1 if(@auth.allow?("join", m.source, m.replyto))
+        when (/^part$/i)
+          part m.target if(m.public? && @auth.allow?("join", m.source, m.replyto))
+        when (/^part\s+(\S+)$/i)
+          part $1 if(@auth.allow?("join", m.source, m.replyto))
+        when (/^quit(?:\s+(.*))?$/i)
+          quit $1 if(@auth.allow?("quit", m.source, m.replyto))
+        when (/^restart$/i)
+          restart if(@auth.allow?("quit", m.source, m.replyto))
+        when (/^hide$/i)
+          join 0 if(@auth.allow?("join", m.source, m.replyto))
+        when (/^save$/i)
+          if(@auth.allow?("config", m.source, m.replyto))
+            save
+            m.okay
+          end
+        when (/^nick\s+(\S+)$/i)
+          nickchg($1) if(@auth.allow?("nick", m.source, m.replyto))
+        when (/^say\s+(\S+)\s+(.*)$/i)
+          say $1, $2 if(@auth.allow?("say", m.source, m.replyto))
+        when (/^action\s+(\S+)\s+(.*)$/i)
+          action $1, $2 if(@auth.allow?("say", m.source, m.replyto))
+        when (/^topic\s+(\S+)\s+(.*)$/i)
+          topic $1, $2 if(@auth.allow?("topic", m.source, m.replyto))
+        when (/^mode\s+(\S+)\s+(\S+)\s+(.*)$/i)
+          mode $1, $2, $3 if(@auth.allow?("mode", m.source, m.replyto))
+        when (/^ping$/i)
+          say m.replyto, "pong"
+        when (/^rescan$/i)
+          if(@auth.allow?("config", m.source, m.replyto))
+            m.okay
+            rescan
+          end
+        when (/^quiet$/i)
+          if(auth.allow?("talk", m.source, m.replyto))
+            m.okay
+            @channels.each_value {|c| c.quiet = true }
+          end
+        when (/^quiet in (\S+)$/i)
+          where = $1
+          if(auth.allow?("talk", m.source, m.replyto))
+            m.okay
+            where.gsub!(/^here$/, m.target) if m.public?
+            @channels[where].quiet = true if(@channels.has_key?(where))
+          end
+        when (/^talk$/i)
+          if(auth.allow?("talk", m.source, m.replyto))
+            @channels.each_value {|c| c.quiet = false }
+            m.okay
+          end
+        when (/^talk in (\S+)$/i)
+          where = $1
+          if(auth.allow?("talk", m.source, m.replyto))
+            where.gsub!(/^here$/, m.target) if m.public?
+            @channels[where].quiet = false if(@channels.has_key?(where))
+            m.okay
+          end
+        when (/^status\??$/i)
+          m.reply status if auth.allow?("status", m.source, m.replyto)
+        when (/^registry stats$/i)
+          if auth.allow?("config", m.source, m.replyto)
+            m.reply @registry.stat.inspect
+          end
+        when (/^(help\s+)?config(\s+|$)/)
+          @config.privmsg(m)
+        when (/^(version)|(introduce yourself)$/i)
+          say m.replyto, "I'm a v. #{$version} rubybot, (c) Tom Gilbert - http://linuxbrit.co.uk/rbot/"
+        when (/^help(?:\s+(.*))?$/i)
+          say m.replyto, help($1)
+          #TODO move these to a "chatback" plugin
+        when (/^(botsnack|ciggie)$/i)
+          say m.replyto, @lang.get("thanks_X") % m.sourcenick if(m.public?)
+          say m.replyto, @lang.get("thanks") if(m.private?)
+        when (/^(hello|howdy|hola|salut|bonjour|sup|niihau|hey|hi(\W|$)|yo(\W|$)).*/i)
+          say m.replyto, @lang.get("hello_X") % m.sourcenick if(m.public?)
+          say m.replyto, @lang.get("hello") if(m.private?)
+        else
+          delegate_privmsg(m)
+      end
+    else
+      # stuff to handle when not addressed
+      case m.message
+        when (/^\s*(hello|howdy|hola|salut|bonjour|sup|niihau|hey|hi(\W|$)|yo(\W|$))[\s,-.]+#{@nick}$/i)
+          say m.replyto, @lang.get("hello_X") % m.sourcenick
+        when (/^#{@nick}!*$/)
+          say m.replyto, @lang.get("hello_X") % m.sourcenick
+        else
+          @keywords.privmsg(m)
+      end
+    end
+  end
+
+  # log a message. Internal use only.
+  def log_sent(type, where, message)
+    case type
+      when "NOTICE"
+        if(where =~ /^#/)
+          log "-=#{@nick}=- #{message}", where
+        elsif (where =~ /(\S*)!.*/)
+             log "[-=#{where}=-] #{message}", $1
+        else
+             log "[-=#{where}=-] #{message}"
+        end
+      when "PRIVMSG"
+        if(where =~ /^#/)
+          log "<#{@nick}> #{message}", where
+        elsif (where =~ /^(\S*)!.*$/)
+          log "[msg(#{where})] #{message}", $1
+        else
+          log "[msg(#{where})] #{message}", where
+        end
+    end
+  end
+
+  def onjoin(m)
+    @channels[m.channel] = IRCChannel.new(m.channel) unless(@channels.has_key?(m.channel))
+    if(m.address?)
+      debug "joined channel #{m.channel}"
+      log "@ Joined channel #{m.channel}", m.channel
+    else
+      log "@ #{m.sourcenick} joined channel #{m.channel}", m.channel
+      @channels[m.channel].users[m.sourcenick] = Hash.new
+      @channels[m.channel].users[m.sourcenick]["mode"] = ""
+    end
+
+    @plugins.delegate("listen", m)
+    @plugins.delegate("join", m)
+  end
+
+  def onpart(m)
+    if(m.address?)
+      debug "left channel #{m.channel}"
+      log "@ Left channel #{m.channel} (#{m.message})", m.channel
+      @channels.delete(m.channel)
+    else
+      log "@ #{m.sourcenick} left channel #{m.channel} (#{m.message})", m.channel
+      @channels[m.channel].users.delete(m.sourcenick)
+    end
+    
+    # delegate to plugins
+    @plugins.delegate("listen", m)
+    @plugins.delegate("part", m)
+  end
+
+  # respond to being kicked from a channel
+  def onkick(m)
+    if(m.address?)
+      debug "kicked from channel #{m.channel}"
+      @channels.delete(m.channel)
+      log "@ You have been kicked from #{m.channel} by #{m.sourcenick} (#{m.message})", m.channel
+    else
+      @channels[m.channel].users.delete(m.sourcenick)
+      log "@ #{m.target} has been kicked from #{m.channel} by #{m.sourcenick} (#{m.message})", m.channel
+    end
+
+    @plugins.delegate("listen", m)
+    @plugins.delegate("kick", m)
+  end
+
+  def ontopic(m)
+    @channels[m.channel] = IRCChannel.new(m.channel) unless(@channels.has_key?(m.channel))
+    @channels[m.channel].topic = m.topic if !m.topic.nil?
+    @channels[m.channel].topic.timestamp = m.timestamp if !m.timestamp.nil?
+    @channels[m.channel].topic.by = m.source if !m.source.nil?
+
+	  debug "topic of channel #{m.channel} is now #{@channels[m.channel].topic}"
+  end
+
+  # delegate a privmsg to auth, keyword or plugin handlers
+  def delegate_privmsg(message)
+    [@auth, @plugins, @keywords].each {|m|
+      break if m.privmsg(message)
+    }
+  end
+
+end
+
+end