lib/rbot/ircbot.rb

   1 require 'thread'
   2 require 'etc'
   3 require 'fileutils'
   4
   5 $debug = false unless $debug
   6 # print +message+ if debugging is enabled
   7 def debug(message=nil)
   8   print "DEBUG: #{message}\n" if($debug && message)
   9   #yield
  10 end
  11
  12 # these first
  13 require 'rbot/rbotconfig'
  14 require 'rbot/config'
  15 require 'rbot/utils'
  16
  17 require 'rbot/rfc2812'
  18 require 'rbot/keywords'
  19 require 'rbot/ircsocket'
  20 require 'rbot/auth'
  21 require 'rbot/timer'
  22 require 'rbot/plugins'
  23 require 'rbot/channel'
  24 require 'rbot/message'
  25 require 'rbot/language'
  26 require 'rbot/dbhash'
  27 require 'rbot/registry'
  28 require 'rbot/httputil'
  29
  30 module Irc
  31
  32 # Main bot class, which manages the various components, receives messages,
  33 # handles them or passes them to plugins, and contains core functionality.
  34 class IrcBot
  35   # the bot's current nickname
  36   attr_reader :nick
  37
  38   # the bot's IrcAuth data
  39   attr_reader :auth
  40
  41   # the bot's BotConfig data
  42   attr_reader :config
  43
  44   # the botclass for this bot (determines configdir among other things)
  45   attr_reader :botclass
  46
  47   # used to perform actions periodically (saves configuration once per minute
  48   # by default)
  49   attr_reader :timer
  50
  51   # bot's Language data
  52   attr_reader :lang
  53
  54   # channel info for channels the bot is in
  55   attr_reader :channels
  56
  57   # bot's irc socket
  58   attr_reader :socket
  59
  60   # bot's object registry, plugins get an interface to this for persistant
  61   # storage (hash interface tied to a bdb file, plugins use Accessors to store
  62   # and restore objects in their own namespaces.)
  63   attr_reader :registry
  64
  65   # bot's httputil help object, for fetching resources via http. Sets up
  66   # proxies etc as defined by the bot configuration/environment
  67   attr_reader :httputil
  68
  69   # create a new IrcBot with botclass +botclass+
  70   def initialize(botclass, params = {})
  71     # BotConfig for the core bot
  72     BotConfig.register BotConfigStringValue.new('server.name',
  73       :default => "localhost", :requires_restart => true,
  74       :desc => "What server should the bot connect to?",
  75       :wizard => true)
  76     BotConfig.register BotConfigIntegerValue.new('server.port',
  77       :default => 6667, :type => :integer, :requires_restart => true,
  78       :desc => "What port should the bot connect to?",
  79       :validate => Proc.new {|v| v > 0}, :wizard => true)
  80     BotConfig.register BotConfigStringValue.new('server.password',
  81       :default => false, :requires_restart => true,
  82       :desc => "Password for connecting to this server (if required)",
  83       :wizard => true)
  84     BotConfig.register BotConfigStringValue.new('server.bindhost',
  85       :default => false, :requires_restart => true,
  86       :desc => "Specific local host or IP for the bot to bind to (if required)",
  87       :wizard => true)
  88     BotConfig.register BotConfigIntegerValue.new('server.reconnect_wait',
  89       :default => 5, :validate => Proc.new{|v| v >= 0},
  90       :desc => "Seconds to wait before attempting to reconnect, on disconnect")
  91     BotConfig.register BotConfigStringValue.new('irc.nick', :default => "rbot",
  92       :desc => "IRC nickname the bot should attempt to use", :wizard => true,
  93       :on_change => Proc.new{|bot, v| bot.sendq "NICK #{v}" })
  94     BotConfig.register BotConfigStringValue.new('irc.user', :default => "rbot",
  95       :requires_restart => true,
  96       :desc => "local user the bot should appear to be", :wizard => true)
  97     BotConfig.register BotConfigArrayValue.new('irc.join_channels',
  98       :default => [], :wizard => true,
  99       :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'")
 100     BotConfig.register BotConfigIntegerValue.new('core.save_every',
 101       :default => 60, :validate => Proc.new{|v| v >= 0},
 102       # TODO change timer via on_change proc
 103       :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example")
 104     BotConfig.register BotConfigFloatValue.new('server.sendq_delay',
 105       :default => 2.0, :validate => Proc.new{|v| v >= 0},
 106       :desc => "(flood prevention) the delay between sending messages to the server (in seconds)",
 107       :on_change => Proc.new {|bot, v| bot.socket.sendq_delay = v })
 108     BotConfig.register BotConfigIntegerValue.new('server.sendq_burst',
 109       :default => 4, :validate => Proc.new{|v| v >= 0},
 110       :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",
 111       :on_change => Proc.new {|bot, v| bot.socket.sendq_burst = v })
 112     BotConfig.register BotConfigIntegerValue.new('server.ping_timeout',
 113       :default => 10, :validate => Proc.new{|v| v >= 0},
 114       :on_change => Proc.new {|bot, v| bot.start_server_pings},
 115       :desc => "reconnect if server doesn't respond to PING within this many seconds (set to 0 to disable)")
 116
 117     @argv = params[:argv]
 118
 119     unless FileTest.directory? Config::datadir
 120       puts "data directory '#{Config::datadir}' not found, did you setup.rb?"
 121       exit 2
 122     end
 123
 124     #botclass = "#{Etc.getpwnam(Etc.getlogin).dir}/.rbot" unless botclass
 125     botclass = "#{ENV['HOME']}/.rbot" unless botclass
 126     @botclass = botclass.gsub(/\/$/, "")
 127
 128     unless FileTest.directory? botclass
 129       puts "no #{botclass} directory found, creating from templates.."
 130       if FileTest.exist? botclass
 131         puts "Error: file #{botclass} exists but isn't a directory"
 132         exit 2
 133       end
 134       FileUtils.cp_r Config::datadir+'/templates', botclass
 135     end
 136
 137     Dir.mkdir("#{botclass}/logs") unless File.exist?("#{botclass}/logs")
 138
 139     @ping_timer = nil
 140     @pong_timer = nil
 141     @last_ping = nil
 142     @startup_time = Time.new
 143     @config = BotConfig.new(self)
 144 # TODO background self after botconfig has a chance to run wizard
 145     @timer = Timer::Timer.new(1.0) # only need per-second granularity
 146     @registry = BotRegistry.new self
 147     @timer.add(@config['core.save_every']) { save } if @config['core.save_every']
 148     @channels = Hash.new
 149     @logs = Hash.new
 150     @httputil = Utils::HttpUtil.new(self)
 151     @lang = Language::Language.new(@config['core.language'])
 152     @keywords = Keywords.new(self)
 153     @auth = IrcAuth.new(self)
 154
 155     Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
 156     @plugins = Plugins::Plugins.new(self, ["#{botclass}/plugins"])
 157
 158     @socket = IrcSocket.new(@config['server.name'], @config['server.port'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'])
 159     @nick = @config['irc.nick']
 160
 161     @client = IrcClient.new
 162     @client[:privmsg] = proc { |data|
 163       message = PrivMessage.new(self, data[:source], data[:target], data[:message])
 164       onprivmsg(message)
 165     }
 166     @client[:notice] = proc { |data|
 167       message = NoticeMessage.new(self, data[:source], data[:target], data[:message])
 168       # pass it off to plugins that want to hear everything
 169       @plugins.delegate "listen", message
 170     }
 171     @client[:motd] = proc { |data|
 172       data[:motd].each_line { |line|
 173         log "MOTD: #{line}", "server"
 174       }
 175     }
 176     @client[:nicktaken] = proc { |data|
 177       nickchg "#{data[:nick]}_"
 178     }
 179     @client[:badnick] = proc {|data|
 180       puts "WARNING, bad nick (#{data[:nick]})"
 181     }
 182     @client[:ping] = proc {|data|
 183       # (jump the queue for pongs)
 184       @socket.puts "PONG #{data[:pingid]}"
 185     }
 186     @client[:pong] = proc {|data|
 187       @last_ping = nil
 188     }
 189     @client[:nick] = proc {|data|
 190       sourcenick = data[:sourcenick]
 191       nick = data[:nick]
 192       m = NickMessage.new(self, data[:source], data[:sourcenick], data[:nick])
 193       if(sourcenick == @nick)
 194         debug "my nick is now #{nick}"
 195         @nick = nick
 196       end
 197       @channels.each {|k,v|
 198         if(v.users.has_key?(sourcenick))
 199           log "@ #{sourcenick} is now known as #{nick}", k
 200           v.users[nick] = v.users[sourcenick]
 201           v.users.delete(sourcenick)
 202         end
 203       }
 204       @plugins.delegate("listen", m)
 205       @plugins.delegate("nick", m)
 206     }
 207     @client[:quit] = proc {|data|
 208       source = data[:source]
 209       sourcenick = data[:sourcenick]
 210       sourceurl = data[:sourceaddress]
 211       message = data[:message]
 212       m = QuitMessage.new(self, data[:source], data[:sourcenick], data[:message])
 213       if(data[:sourcenick] =~ /#{Regexp.escape(@nick)}/i)
 214       else
 215         @channels.each {|k,v|
 216           if(v.users.has_key?(sourcenick))
 217             log "@ Quit: #{sourcenick}: #{message}", k
 218             v.users.delete(sourcenick)
 219           end
 220         }
 221       end
 222       @plugins.delegate("listen", m)
 223       @plugins.delegate("quit", m)
 224     }
 225     @client[:mode] = proc {|data|
 226       source = data[:source]
 227       sourcenick = data[:sourcenick]
 228       sourceurl = data[:sourceaddress]
 229       channel = data[:channel]
 230       targets = data[:targets]
 231       modestring = data[:modestring]
 232       log "@ Mode #{modestring} #{targets} by #{sourcenick}", channel
 233     }
 234     @client[:welcome] = proc {|data|
 235       log "joined server #{data[:source]} as #{data[:nick]}", "server"
 236       debug "I think my nick is #{@nick}, server thinks #{data[:nick]}"
 237       if data[:nick] && data[:nick].length > 0
 238         @nick = data[:nick]
 239       end
 240
 241       @plugins.delegate("connect")
 242
 243       @config['irc.join_channels'].each {|c|
 244         debug "autojoining channel #{c}"
 245         if(c =~ /^(\S+)\s+(\S+)$/i)
 246           join $1, $2
 247         else
 248           join c if(c)
 249         end
 250       }
 251     }
 252     @client[:join] = proc {|data|
 253       m = JoinMessage.new(self, data[:source], data[:channel], data[:message])
 254       onjoin(m)
 255     }
 256     @client[:part] = proc {|data|
 257       m = PartMessage.new(self, data[:source], data[:channel], data[:message])
 258       onpart(m)
 259     }
 260     @client[:kick] = proc {|data|
 261       m = KickMessage.new(self, data[:source], data[:target],data[:channel],data[:message])
 262       onkick(m)
 263     }
 264     @client[:invite] = proc {|data|
 265       if(data[:target] =~ /^#{Regexp.escape(@nick)}$/i)
 266         join data[:channel] if (@auth.allow?("join", data[:source], data[:sourcenick]))
 267       end
 268     }
 269     @client[:changetopic] = proc {|data|
 270       channel = data[:channel]
 271       sourcenick = data[:sourcenick]
 272       topic = data[:topic]
 273       timestamp = data[:unixtime] || Time.now.to_i
 274       if(sourcenick == @nick)
 275         log "@ I set topic \"#{topic}\"", channel
 276       else
 277         log "@ #{sourcenick} set topic \"#{topic}\"", channel
 278       end
 279       m = TopicMessage.new(self, data[:source], data[:channel], timestamp, data[:topic])
 280
 281       ontopic(m)
 282       @plugins.delegate("listen", m)
 283       @plugins.delegate("topic", m)
 284     }
 285     @client[:topic] = @client[:topicinfo] = proc {|data|
 286       channel = data[:channel]
 287       m = TopicMessage.new(self, data[:source], data[:channel], data[:unixtime], data[:topic])
 288         ontopic(m)
 289     }
 290     @client[:names] = proc {|data|
 291       channel = data[:channel]
 292       users = data[:users]
 293       unless(@channels[channel])
 294         puts "bug: got names for channel '#{channel}' I didn't think I was in\n"
 295         exit 2
 296       end
 297       @channels[channel].users.clear
 298       users.each {|u|
 299         @channels[channel].users[u[0].sub(/^[@&~+]/, '')] = ["mode", u[1]]
 300       }
 301     }
 302     @client[:unknown] = proc {|data|
 303       #debug "UNKNOWN: #{data[:serverstring]}"
 304       log data[:serverstring], ":unknown"
 305     }
 306   end
 307
 308   # connect the bot to IRC
 309   def connect
 310     begin
 311       trap("SIGTERM") { quit }
 312       trap("SIGHUP") { quit }
 313       trap("SIGINT") { quit }
 314     rescue
 315       debug "failed to trap signals, probably running on windows?"
 316     end
 317     begin
 318       @socket.connect
 319       rescue => e
 320       raise "failed to connect to IRC server at #{@config['server.name']} #{@config['server.port']}: " + e
 321     end
 322     @socket.puts "PASS " + @config['server.password'] if @config['server.password']
 323     @socket.puts "NICK #{@nick}\nUSER #{@config['irc.user']} 4 #{@config['server.name']} :Ruby bot. (c) Tom Gilbert"
 324     start_server_pings
 325   end
 326
 327   # begin event handling loop
 328   def mainloop
 329     while true
 330       begin
 331       connect
 332       @timer.start
 333
 334         while true
 335           if @socket.select
 336             break unless reply = @socket.gets
 337             @client.process reply
 338           end
 339         end
 340       # I despair of this. Some of my users get "connection reset by peer"
 341       # exceptions that ARENT SocketError's. How am I supposed to handle
 342       # that?
 343       #rescue TimeoutError, SocketError => e
 344       rescue Exception => e
 345         puts "network exception: connection closed: #{e}"
 346         puts e.backtrace.join("\n")
 347         @socket.shutdown # now we reconnect
 348       rescue => e
 349         puts "unexpected exception: connection closed: #{e.inspect}"
 350         puts e.backtrace.join("\n")
 351         exit 2
 352       end
 353
 354       puts "disconnected"
 355       @last_ping = nil
 356       @channels.clear
 357       @socket.clearq
 358
 359       puts "waiting to reconnect"
 360       sleep @config['server.reconnect_wait']
 361     end
 362   end
 363
 364   # type:: message type
 365   # where:: message target
 366   # message:: message text
 367   # send message +message+ of type +type+ to target +where+
 368   # Type can be PRIVMSG, NOTICE, etc, but those you should really use the
 369   # relevant say() or notice() methods. This one should be used for IRCd
 370   # extensions you want to use in modules.
 371   def sendmsg(type, where, message)
 372     # limit it 440 chars + CRLF.. so we have to split long lines
 373     left = 440 - type.length - where.length - 3
 374     begin
 375       if(left >= message.length)
 376         sendq("#{type} #{where} :#{message}")
 377         log_sent(type, where, message)
 378         return
 379       end
 380       line = message.slice!(0, left)
 381       lastspace = line.rindex(/\s+/)
 382       if(lastspace)
 383         message = line.slice!(lastspace, line.length) + message
 384         message.gsub!(/^\s+/, "")
 385       end
 386       sendq("#{type} #{where} :#{line}")
 387       log_sent(type, where, line)
 388     end while(message.length > 0)
 389   end
 390
 391   # queue an arbitraty message for the server
 392   def sendq(message="")
 393     # temporary
 394     @socket.queue(message)
 395   end
 396
 397   # send a notice message to channel/nick +where+
 398   def notice(where, message)
 399     message.each_line { |line|
 400       line.chomp!
 401       next unless(line.length > 0)
 402       sendmsg("NOTICE", where, line)
 403     }
 404   end
 405
 406   # say something (PRIVMSG) to channel/nick +where+
 407   def say(where, message)
 408     message.to_s.gsub(/[\r\n]+/, "\n").each_line { |line|
 409       line.chomp!
 410       next unless(line.length > 0)
 411       unless((where =~ /^#/) && (@channels.has_key?(where) && @channels[where].quiet))
 412         sendmsg("PRIVMSG", where, line)
 413       end
 414     }
 415   end
 416
 417   # perform a CTCP action with message +message+ to channel/nick +where+
 418   def action(where, message)
 419     sendq("PRIVMSG #{where} :\001ACTION #{message}\001")
 420     if(where =~ /^#/)
 421       log "* #{@nick} #{message}", where
 422     elsif (where =~ /^(\S*)!.*$/)
 423          log "* #{@nick}[#{where}] #{message}", $1
 424     else
 425          log "* #{@nick}[#{where}] #{message}", where
 426     end
 427   end
 428
 429   # quick way to say "okay" (or equivalent) to +where+
 430   def okay(where)
 431     say where, @lang.get("okay")
 432   end
 433
 434   # log message +message+ to a file determined by +where+. +where+ can be a
 435   # channel name, or a nick for private message logging
 436   def log(message, where="server")
 437     message.chomp!
 438     stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S")
 439     unless(@logs.has_key?(where))
 440       @logs[where] = File.new("#{@botclass}/logs/#{where}", "a")
 441       @logs[where].sync = true
 442     end
 443     @logs[where].puts "[#{stamp}] #{message}"
 444     #debug "[#{stamp}] <#{where}> #{message}"
 445   end
 446
 447   # set topic of channel +where+ to +topic+
 448   def topic(where, topic)
 449     sendq "TOPIC #{where} :#{topic}"
 450   end
 451
 452   # disconnect from the server and cleanup all plugins and modules
 453   def shutdown(message = nil)
 454     trap("SIGTERM", "DEFAULT")
 455     trap("SIGHUP", "DEFAULT")
 456     trap("SIGINT", "DEFAULT")
 457     message = @lang.get("quit") if (message.nil? || message.empty?)
 458     @socket.clearq
 459     save
 460     @plugins.cleanup
 461     @channels.each_value {|v|
 462       log "@ quit (#{message})", v.name
 463     }
 464     @socket.puts "QUIT :#{message}"
 465     @socket.flush
 466     @socket.shutdown
 467     @registry.close
 468     puts "rbot quit (#{message})"
 469   end
 470
 471   # message:: optional IRC quit message
 472   # quit IRC, shutdown the bot
 473   def quit(message=nil)
 474     shutdown(message)
 475     exit 0
 476   end
 477
 478   # totally shutdown and respawn the bot
 479   def restart(message = false)
 480     msg = message ? message : "restarting, back in #{@config['server.reconnect_wait']}..."
 481     shutdown(msg)
 482     sleep @config['server.reconnect_wait']
 483     # now we re-exec
 484     exec($0, *@argv)
 485   end
 486
 487   # call the save method for bot's config, keywords, auth and all plugins
 488   def save
 489     @registry.flush
 490     @config.save
 491     @keywords.save
 492     @auth.save
 493     @plugins.save
 494   end
 495
 496   # call the rescan method for the bot's lang, keywords and all plugins
 497   def rescan
 498     @lang.rescan
 499     @plugins.rescan
 500     @keywords.rescan
 501   end
 502
 503   # channel:: channel to join
 504   # key::     optional channel key if channel is +s
 505   # join a channel
 506   def join(channel, key=nil)
 507     if(key)
 508       sendq "JOIN #{channel} :#{key}"
 509     else
 510       sendq "JOIN #{channel}"
 511     end
 512   end
 513
 514   # part a channel
 515   def part(channel, message="")
 516     sendq "PART #{channel} :#{message}"
 517   end
 518
 519   # attempt to change bot's nick to +name+
 520   def nickchg(name)
 521       sendq "NICK #{name}"
 522   end
 523
 524   # changing mode
 525   def mode(channel, mode, target)
 526       sendq "MODE #{channel} #{mode} #{target}"
 527   end
 528
 529   # m::     message asking for help
 530   # topic:: optional topic help is requested for
 531   # respond to online help requests
 532   def help(topic=nil)
 533     topic = nil if topic == ""
 534     case topic
 535     when nil
 536       helpstr = "help topics: core, auth, keywords"
 537       helpstr += @plugins.helptopics
 538       helpstr += " (help <topic> for more info)"
 539     when /^core$/i
 540       helpstr = corehelp
 541     when /^core\s+(.+)$/i
 542       helpstr = corehelp $1
 543     when /^auth$/i
 544       helpstr = @auth.help
 545     when /^auth\s+(.+)$/i
 546       helpstr = @auth.help $1
 547     when /^keywords$/i
 548       helpstr = @keywords.help
 549     when /^keywords\s+(.+)$/i
 550       helpstr = @keywords.help $1
 551     else
 552       unless(helpstr = @plugins.help(topic))
 553         helpstr = "no help for topic #{topic}"
 554       end
 555     end
 556     return helpstr
 557   end
 558
 559   # returns a string describing the current status of the bot (uptime etc)
 560   def status
 561     secs_up = Time.new - @startup_time
 562     uptime = Utils.secs_to_string secs_up
 563     return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@registry.length} items stored in registry, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
 564   end
 565
 566   # we'll ping the server every 30 seconds or so, and expect a response
 567   # before the next one come around..
 568   def start_server_pings
 569     @last_ping = nil
 570     # stop existing timers if running
 571     unless @ping_timer.nil?
 572       @timer.remove @ping_timer
 573       @ping_timer = nil
 574     end
 575     unless @pong_timer.nil?
 576       @timer.remove @pong_timer
 577       @pong_timer = nil
 578     end
 579     return unless @config['server.ping_timeout'] > 0
 580     # we want to respond to a hung server within 30 secs or so
 581     @ping_timer = @timer.add(30) {
 582       @last_ping = Time.now
 583       @socket.puts "PING :rbot"
 584     }
 585     @pong_timer = @timer.add(10) {
 586       unless @last_ping.nil?
 587         diff = Time.now - @last_ping
 588         unless diff < @config['server.ping_timeout']
 589           debug "no PONG from server for #{diff} seconds, reconnecting"
 590           begin
 591             @socket.shutdown
 592           rescue
 593             debug "couldn't shutdown connection (already shutdown?)"
 594           end
 595           @last_ping = nil
 596         end
 597       end
 598     }
 599   end
 600
 601   private
 602
 603   # handle help requests for "core" topics
 604   def corehelp(topic="")
 605     case topic
 606       when "quit"
 607         return "quit [<message>] => quit IRC with message <message>"
 608       when "restart"
 609         return "restart => completely stop and restart the bot (including reconnect)"
 610       when "join"
 611         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"
 612       when "part"
 613         return "part <channel> => part channel <channel>"
 614       when "hide"
 615         return "hide => part all channels"
 616       when "save"
 617         return "save => save current dynamic data and configuration"
 618       when "rescan"
 619         return "rescan => reload modules and static facts"
 620       when "nick"
 621         return "nick <nick> => attempt to change nick to <nick>"
 622       when "say"
 623         return "say <channel>|<nick> <message> => say <message> to <channel> or in private message to <nick>"
 624       when "action"
 625         return "action <channel>|<nick> <message> => does a /me <message> to <channel> or in private message to <nick>"
 626       when "topic"
 627         return "topic <channel> <message> => set topic of <channel> to <message>"
 628       when "quiet"
 629         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>"
 630       when "talk"
 631         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>"
 632       when "version"
 633         return "version => describes software version"
 634       when "botsnack"
 635         return "botsnack => reward #{@nick} for being good"
 636       when "hello"
 637         return "hello|hi|hey|yo [#{@nick}] => greet the bot"
 638       else
 639         return "Core help topics: quit, restart, config, join, part, hide, save, rescan, nick, say, action, topic, quiet, talk, version, botsnack, hello"
 640     end
 641   end
 642
 643   # handle incoming IRC PRIVMSG +m+
 644   def onprivmsg(m)
 645     # log it first
 646     if(m.action?)
 647       if(m.private?)
 648         log "* [#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick
 649       else
 650         log "* #{m.sourcenick} #{m.message}", m.target
 651       end
 652     else
 653       if(m.public?)
 654         log "<#{m.sourcenick}> #{m.message}", m.target
 655       else
 656         log "[#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick
 657       end
 658     end
 659
 660     # pass it off to plugins that want to hear everything
 661     @plugins.delegate "listen", m
 662
 663     if(m.private? && m.message =~ /^\001PING\s+(.+)\001/)
 664       notice m.sourcenick, "\001PING #$1\001"
 665       log "@ #{m.sourcenick} pinged me"
 666       return
 667     end
 668
 669     if(m.address?)
 670       case m.message
 671         when (/^join\s+(\S+)\s+(\S+)$/i)
 672           join $1, $2 if(@auth.allow?("join", m.source, m.replyto))
 673         when (/^join\s+(\S+)$/i)
 674           join $1 if(@auth.allow?("join", m.source, m.replyto))
 675         when (/^part$/i)
 676           part m.target if(m.public? && @auth.allow?("join", m.source, m.replyto))
 677         when (/^part\s+(\S+)$/i)
 678           part $1 if(@auth.allow?("join", m.source, m.replyto))
 679         when (/^quit(?:\s+(.*))?$/i)
 680           quit $1 if(@auth.allow?("quit", m.source, m.replyto))
 681         when (/^restart(?:\s+(.*))?$/i)
 682           restart $1 if(@auth.allow?("quit", m.source, m.replyto))
 683         when (/^hide$/i)
 684           join 0 if(@auth.allow?("join", m.source, m.replyto))
 685         when (/^save$/i)
 686           if(@auth.allow?("config", m.source, m.replyto))
 687             save
 688             m.okay
 689           end
 690         when (/^nick\s+(\S+)$/i)
 691           nickchg($1) if(@auth.allow?("nick", m.source, m.replyto))
 692         when (/^say\s+(\S+)\s+(.*)$/i)
 693           say $1, $2 if(@auth.allow?("say", m.source, m.replyto))
 694         when (/^action\s+(\S+)\s+(.*)$/i)
 695           action $1, $2 if(@auth.allow?("say", m.source, m.replyto))
 696         when (/^topic\s+(\S+)\s+(.*)$/i)
 697           topic $1, $2 if(@auth.allow?("topic", m.source, m.replyto))
 698         when (/^mode\s+(\S+)\s+(\S+)\s+(.*)$/i)
 699           mode $1, $2, $3 if(@auth.allow?("mode", m.source, m.replyto))
 700         when (/^ping$/i)
 701           say m.replyto, "pong"
 702         when (/^rescan$/i)
 703           if(@auth.allow?("config", m.source, m.replyto))
 704             m.okay
 705             rescan
 706           end
 707         when (/^quiet$/i)
 708           if(auth.allow?("talk", m.source, m.replyto))
 709             m.okay
 710             @channels.each_value {|c| c.quiet = true }
 711           end
 712         when (/^quiet in (\S+)$/i)
 713           where = $1
 714           if(auth.allow?("talk", m.source, m.replyto))
 715             m.okay
 716             where.gsub!(/^here$/, m.target) if m.public?
 717             @channels[where].quiet = true if(@channels.has_key?(where))
 718           end
 719         when (/^talk$/i)
 720           if(auth.allow?("talk", m.source, m.replyto))
 721             @channels.each_value {|c| c.quiet = false }
 722             m.okay
 723           end
 724         when (/^talk in (\S+)$/i)
 725           where = $1
 726           if(auth.allow?("talk", m.source, m.replyto))
 727             where.gsub!(/^here$/, m.target) if m.public?
 728             @channels[where].quiet = false if(@channels.has_key?(where))
 729             m.okay
 730           end
 731         when (/^status\??$/i)
 732           m.reply status if auth.allow?("status", m.source, m.replyto)
 733         when (/^registry stats$/i)
 734           if auth.allow?("config", m.source, m.replyto)
 735             m.reply @registry.stat.inspect
 736           end
 737         when (/^(help\s+)?config(\s+|$)/)
 738           @config.privmsg(m)
 739         when (/^(version)|(introduce yourself)$/i)
 740           say m.replyto, "I'm a v. #{$version} rubybot, (c) Tom Gilbert - http://linuxbrit.co.uk/rbot/"
 741         when (/^help(?:\s+(.*))?$/i)
 742           say m.replyto, help($1)
 743           #TODO move these to a "chatback" plugin
 744         when (/^(botsnack|ciggie)$/i)
 745           say m.replyto, @lang.get("thanks_X") % m.sourcenick if(m.public?)
 746           say m.replyto, @lang.get("thanks") if(m.private?)
 747         when (/^(hello|howdy|hola|salut|bonjour|sup|niihau|hey|hi(\W|$)|yo(\W|$)).*/i)
 748           say m.replyto, @lang.get("hello_X") % m.sourcenick if(m.public?)
 749           say m.replyto, @lang.get("hello") if(m.private?)
 750         else
 751           delegate_privmsg(m)
 752       end
 753     else
 754       # stuff to handle when not addressed
 755       case m.message
 756         when (/^\s*(hello|howdy|hola|salut|bonjour|sup|niihau|hey|hi|yo(\W|$))[\s,-.]+#{Regexp.escape(@nick)}$/i)
 757           say m.replyto, @lang.get("hello_X") % m.sourcenick
 758         when (/^#{Regexp.escape(@nick)}!*$/)
 759           say m.replyto, @lang.get("hello_X") % m.sourcenick
 760         else
 761           @keywords.privmsg(m)
 762       end
 763     end
 764   end
 765
 766   # log a message. Internal use only.
 767   def log_sent(type, where, message)
 768     case type
 769       when "NOTICE"
 770         if(where =~ /^#/)
 771           log "-=#{@nick}=- #{message}", where
 772         elsif (where =~ /(\S*)!.*/)
 773              log "[-=#{where}=-] #{message}", $1
 774         else
 775              log "[-=#{where}=-] #{message}"
 776         end
 777       when "PRIVMSG"
 778         if(where =~ /^#/)
 779           log "<#{@nick}> #{message}", where
 780         elsif (where =~ /^(\S*)!.*$/)
 781           log "[msg(#{where})] #{message}", $1
 782         else
 783           log "[msg(#{where})] #{message}", where
 784         end
 785     end
 786   end
 787
 788   def onjoin(m)
 789     @channels[m.channel] = IRCChannel.new(m.channel) unless(@channels.has_key?(m.channel))
 790     if(m.address?)
 791       debug "joined channel #{m.channel}"
 792       log "@ Joined channel #{m.channel}", m.channel
 793     else
 794       log "@ #{m.sourcenick} joined channel #{m.channel}", m.channel
 795       @channels[m.channel].users[m.sourcenick] = Hash.new
 796       @channels[m.channel].users[m.sourcenick]["mode"] = ""
 797     end
 798
 799     @plugins.delegate("listen", m)
 800     @plugins.delegate("join", m)
 801   end
 802
 803   def onpart(m)
 804     if(m.address?)
 805       debug "left channel #{m.channel}"
 806       log "@ Left channel #{m.channel} (#{m.message})", m.channel
 807       @channels.delete(m.channel)
 808     else
 809       log "@ #{m.sourcenick} left channel #{m.channel} (#{m.message})", m.channel
 810       @channels[m.channel].users.delete(m.sourcenick)
 811     end
 812
 813     # delegate to plugins
 814     @plugins.delegate("listen", m)
 815     @plugins.delegate("part", m)
 816   end
 817
 818   # respond to being kicked from a channel
 819   def onkick(m)
 820     if(m.address?)
 821       debug "kicked from channel #{m.channel}"
 822       @channels.delete(m.channel)
 823       log "@ You have been kicked from #{m.channel} by #{m.sourcenick} (#{m.message})", m.channel
 824     else
 825       @channels[m.channel].users.delete(m.sourcenick)
 826       log "@ #{m.target} has been kicked from #{m.channel} by #{m.sourcenick} (#{m.message})", m.channel
 827     end
 828
 829     @plugins.delegate("listen", m)
 830     @plugins.delegate("kick", m)
 831   end
 832
 833   def ontopic(m)
 834     @channels[m.channel] = IRCChannel.new(m.channel) unless(@channels.has_key?(m.channel))
 835     @channels[m.channel].topic = m.topic if !m.topic.nil?
 836     @channels[m.channel].topic.timestamp = m.timestamp if !m.timestamp.nil?
 837     @channels[m.channel].topic.by = m.source if !m.source.nil?
 838
 839           debug "topic of channel #{m.channel} is now #{@channels[m.channel].topic}"
 840   end
 841
 842   # delegate a privmsg to auth, keyword or plugin handlers
 843   def delegate_privmsg(message)
 844     [@auth, @plugins, @keywords].each {|m|
 845       break if m.privmsg(message)
 846     }
 847   end
 848 end
 849
 850 end