-# Copyright (C) 2002 Tom Gilbert.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to
-# deal in the Software without restriction, including without limitation the
-# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
-# sell copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies of the Software and its documentation and acknowledgment shall be
-# given in the documentation and software packages that this Software was
-# used.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
-# THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
require 'thread'
require 'etc'
require 'fileutils'
+$debug = false unless $debug
+# print +message+ if debugging is enabled
+def debug(message=nil)
+ stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S")
+ print "D: [#{stamp}] #{message}\n" if($debug && message)
+ #yield
+end
+
# these first
require 'rbot/rbotconfig'
require 'rbot/config'
module Irc
-# Main bot class, which receives messages, handles them or passes them to
-# plugins, and stores runtime data
+# 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
# 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
: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 })
+ BotConfig.register BotConfigIntegerValue.new('server.ping_timeout',
+ :default => 10, :validate => Proc.new{|v| v >= 0},
+ :on_change => Proc.new {|bot, v| bot.start_server_pings},
+ :desc => "reconnect if server doesn't respond to PING within this many seconds (set to 0 to disable)")
@argv = params[:argv]
- unless FileTest.directory? Config::DATADIR
- puts "data directory '#{Config::DATADIR}' not found, did you install.rb?"
+ unless FileTest.directory? Config::datadir
+ puts "data directory '#{Config::datadir}' not found, did you setup.rb?"
exit 2
end
- botclass = "/home/#{Etc.getlogin}/.rbot" unless botclass
+ #botclass = "#{Etc.getpwnam(Etc.getlogin).dir}/.rbot" unless botclass
+ botclass = "#{ENV['HOME']}/.rbot" unless botclass
@botclass = botclass.gsub(/\/$/, "")
unless FileTest.directory? botclass
puts "Error: file #{botclass} exists but isn't a directory"
exit 2
end
- FileUtils.cp_r Config::DATADIR+'/templates', botclass
+ FileUtils.cp_r Config::datadir+'/templates', botclass
end
Dir.mkdir("#{botclass}/logs") unless File.exist?("#{botclass}/logs")
+ @ping_timer = nil
+ @pong_timer = nil
+ @last_ping = nil
@startup_time = Time.new
@config = BotConfig.new(self)
+# TODO background self after botconfig has a chance to run wizard
@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)
@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"])
+ @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"])
+ @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|
+ @client[:motd] = proc { |data|
+ data[:motd].each_line { |line|
log "MOTD: #{line}", "server"
}
}
- @client["NICKTAKEN"] = proc { |data|
- nickchg "#{@nick}_"
+ @client[:nicktaken] = proc { |data|
+ nickchg "#{data[:nick]}_"
}
- @client["BADNICK"] = proc {|data|
- puts "WARNING, bad nick (#{data['NICK']})"
+ @client[:badnick] = proc {|data|
+ puts "WARNING, bad nick (#{data[:nick]})"
}
- @client["PING"] = proc {|data|
+ @client[:ping] = proc {|data|
# (jump the queue for pongs)
- @socket.puts "PONG #{data['PINGID']}"
+ @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"])
+ @client[:pong] = proc {|data|
+ @last_ping = nil
+ }
+ @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|
@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)
+ @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] =~ /#{Regexp.escape(@nick)}/i)
else
@channels.each {|k,v|
if(v.users.has_key?(sourcenick))
@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"]
+ @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
- if(@config['irc.quser'])
- # TODO move this to a plugin
- debug "authing with Q using #{@config['quakenet.user']} #{@config['quakenet.auth']}"
- @socket.puts "PRIVMSG Q@CServe.quakenet.org :auth #{@config['quakenet.user']} #{@config['quakenet.auth']}"
+ @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)
end
}
}
- @client["JOIN"] = proc {|data|
- m = JoinMessage.new(self, data["SOURCE"], data["CHANNEL"], data["MESSAGE"])
+ @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"])
+ @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"])
+ @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"]))
+ @client[:invite] = proc {|data|
+ if(data[:target] =~ /^#{Regexp.escape(@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
+ @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"])
+ 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"])
+ @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"]
+ @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
@channels[channel].users[u[0].sub(/^[@&~+]/, '')] = ["mode", u[1]]
}
}
- @client["UNKNOWN"] = proc {|data|
- debug "UNKNOWN: #{data['SERVERSTRING']}"
+ @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
+ trap("SIGINT") { quit }
+ trap("SIGTERM") { quit }
+ trap("SIGHUP") { quit }
+ rescue
+ debug "failed to trap signals, probably running on windows?"
+ end
begin
@socket.connect
- rescue => e
+ 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"
+ start_server_pings
end
# begin event handling loop
def mainloop
while true
+ begin
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}"
+ # I despair of this. Some of my users get "connection reset by peer"
+ # exceptions that ARENT SocketError's. How am I supposed to handle
+ # that?
+ #rescue TimeoutError, SocketError => e
+ rescue SystemExit
+ exit 0
+ rescue Exception => e
+ puts "network exception: connection closed: #{e.inspect}"
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}"
+ @socket.shutdown # now we reconnect
+ rescue => e
+ puts "unexpected exception: connection closed: #{e.inspect}"
puts e.backtrace.join("\n")
exit 2
end
puts "disconnected"
+ @last_ping = nil
@channels.clear
@socket.clearq
end while(message.length > 0)
end
+ # queue an arbitraty message for the server
def sendq(message="")
# temporary
@socket.queue(message)
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")
+ begin
+ trap("SIGINT", "DEFAULT")
+ trap("SIGTERM", "DEFAULT")
+ trap("SIGHUP", "DEFAULT")
+ rescue
+ debug "failed to trap signals, probably running on windows?"
+ end
message = @lang.get("quit") if (message.nil? || message.empty?)
@socket.clearq
save
@channels.each_value {|v|
log "@ quit (#{message})", v.name
}
+ @registry.close
@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
+ begin
+ shutdown(message)
+ ensure
+ exit 0
+ end
end
# totally shutdown and respawn the bot
- def restart
- shutdown("restarting, back in #{@config['server.reconnect_wait']}...")
+ def restart(message = false)
+ msg = message ? message : "restarting, back in #{@config['server.reconnect_wait']}..."
+ shutdown(msg)
sleep @config['server.reconnect_wait']
# now we re-exec
exec($0, *@argv)
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
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
+ # we'll ping the server every 30 seconds or so, and expect a response
+ # before the next one come around..
+ def start_server_pings
+ @last_ping = nil
+ # stop existing timers if running
+ unless @ping_timer.nil?
+ @timer.remove @ping_timer
+ @ping_timer = nil
+ end
+ unless @pong_timer.nil?
+ @timer.remove @pong_timer
+ @pong_timer = nil
+ end
+ return unless @config['server.ping_timeout'] > 0
+ # we want to respond to a hung server within 30 secs or so
+ @ping_timer = @timer.add(30) {
+ @last_ping = Time.now
+ @socket.puts "PING :rbot"
+ }
+ @pong_timer = @timer.add(10) {
+ unless @last_ping.nil?
+ diff = Time.now - @last_ping
+ unless diff < @config['server.ping_timeout']
+ debug "no PONG from server for #{diff} seconds, reconnecting"
+ begin
+ @socket.shutdown
+ # TODO
+ # raise an exception to get back to the mainloop
+ rescue
+ debug "couldn't shutdown connection (already shutdown?)"
+ end
+ @last_ping = nil
+ end
+ end
+ }
+ end
private
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 (/^restart(?:\s+(.*))?$/i)
+ restart $1 if(@auth.allow?("quit", m.source, m.replyto))
when (/^hide$/i)
join 0 if(@auth.allow?("join", m.source, m.replyto))
when (/^save$/i)
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)
+ when (/^\s*(hello|howdy|hola|salut|bonjour|sup|niihau|hey|hi|yo(\W|$))[\s,-.]+#{Regexp.escape(@nick)}$/i)
say m.replyto, @lang.get("hello_X") % m.sourcenick
- when (/^#{@nick}!*$/)
+ when (/^#{Regexp.escape(@nick)}!*$/)
say m.replyto, @lang.get("hello_X") % m.sourcenick
else
@keywords.privmsg(m)
break if m.privmsg(message)
}
end
-
end
end
projects / user / henk / code / ruby / rbot.git / blobdiff