X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fircbot.rb;h=bd19e6375e3b4021703c3c25a678714b9e083189;hb=edd1cf77be07ae507014574141e920ad23eb164d;hp=65b9417269ce5ca31d488fc8e768ddf7832b4527;hpb=2a27c12fffa359898c5601a211fe19425da82fa6;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/ircbot.rb b/lib/rbot/ircbot.rb index 65b94172..bd19e637 100644 --- a/lib/rbot/ircbot.rb +++ b/lib/rbot/ircbot.rb @@ -69,13 +69,12 @@ $interrupted = 0 # these first require 'rbot/rbotconfig' require 'rbot/config' -require 'rbot/utils' +# require 'rbot/utils' require 'rbot/irc' require 'rbot/rfc2812' -require 'rbot/keywords' require 'rbot/ircsocket' -require 'rbot/auth' +require 'rbot/botuser' require 'rbot/timer' require 'rbot/plugins' # require 'rbot/channel' @@ -83,7 +82,7 @@ require 'rbot/message' require 'rbot/language' require 'rbot/dbhash' require 'rbot/registry' -require 'rbot/httputil' +# require 'rbot/httputil' module Irc @@ -103,13 +102,13 @@ class IrcBot # by default) attr_reader :timer + # synchronize with this mutex while touching permanent data files: + # saving, flushing, cleaning up ... + attr_reader :save_mutex + # bot's Language data attr_reader :lang - # server the bot is connected to - # TODO multiserver - attr_reader :server - # bot's irc socket # TODO multiserver attr_reader :socket @@ -126,8 +125,17 @@ class IrcBot # proxies etc as defined by the bot configuration/environment attr_reader :httputil + # server we are connected to + # TODO multiserver + def server + @client.server + end + # bot User in the client/server connection - attr_reader :myself + # TODO multiserver + def myself + @client.client + end # bot User in the client/server connection def nick @@ -146,6 +154,9 @@ class IrcBot :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 BotConfigBooleanValue.new('server.ssl', + :default => false, :requires_restart => true, :wizard => true, + :desc => "Use SSL to connect to this server?") BotConfig.register BotConfigStringValue.new('server.password', :default => false, :requires_restart => true, :desc => "Password for connecting to this server (if required)", @@ -165,13 +176,8 @@ class IrcBot :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", :on_change => Proc.new {|bot, v| bot.socket.sendq_burst = v }) - BotConfig.register BotConfigStringValue.new('server.byterate', - :default => "400/2", :validate => Proc.new{|v| v.match(/\d+\/\d/)}, - :desc => "(flood prevention) max bytes/seconds rate to send the server. Most ircd's have limits of 512 bytes/2 seconds", - :on_change => Proc.new {|bot, v| bot.socket.byterate = v }) BotConfig.register BotConfigIntegerValue.new('server.ping_timeout', :default => 30, :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)") BotConfig.register BotConfigStringValue.new('irc.nick', :default => "rbot", @@ -189,7 +195,21 @@ class IrcBot BotConfig.register BotConfigIntegerValue.new('core.save_every', :default => 60, :validate => Proc.new{|v| v >= 0}, - # TODO change timer via on_change proc + :on_change => Proc.new { |bot, v| + if @save_timer + if v > 0 + @timer.reschedule(@save_timer, v) + @timer.unblock(@save_timer) + else + @timer.block(@save_timer) + end + else + if v > 0 + @save_timer = @timer.add(v) { bot.save } + end + # Nothing to do when v == 0 + end + }, :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example)") BotConfig.register BotConfigBooleanValue.new('core.run_as_daemon', @@ -215,8 +235,57 @@ class IrcBot :validate => Proc.new { |v| v > 0 }, :desc => "Maximum console messages logfile size (in megabytes)") + BotConfig.register BotConfigEnumValue.new('send.newlines', + :values => ['split', 'join'], :default => 'split', + :on_change => Proc.new { |bot, v| + bot.set_default_send_options :newlines => v.to_sym + }, + :desc => "When set to split, messages with embedded newlines will be sent as separate lines. When set to join, newlines will be replaced by the value of join_with") + BotConfig.register BotConfigStringValue.new('send.join_with', + :default => ' ', + :on_change => Proc.new { |bot, v| + bot.set_default_send_options :join_with => v.dup + }, + :desc => "String used to replace newlines when send.newlines is set to join") + BotConfig.register BotConfigIntegerValue.new('send.max_lines', + :default => 0, + :validate => Proc.new { |v| v >= 0 }, + :on_change => Proc.new { |bot, v| + bot.set_default_send_options :max_lines => v + }, + :desc => "Maximum number of IRC lines to send for each message (set to 0 for no limit)") + BotConfig.register BotConfigEnumValue.new('send.overlong', + :values => ['split', 'truncate'], :default => 'split', + :on_change => Proc.new { |bot, v| + bot.set_default_send_options :overlong => v.to_sym + }, + :desc => "When set to split, messages which are too long to fit in a single IRC line are split into multiple lines. When set to truncate, long messages are truncated to fit the IRC line length") + BotConfig.register BotConfigStringValue.new('send.split_at', + :default => '\s+', + :on_change => Proc.new { |bot, v| + bot.set_default_send_options :split_at => Regexp.new(v) + }, + :desc => "A regular expression that should match the split points for overlong messages (see send.overlong)") + BotConfig.register BotConfigBooleanValue.new('send.purge_split', + :default => true, + :on_change => Proc.new { |bot, v| + bot.set_default_send_options :purge_split => v + }, + :desc => "Set to true if the splitting boundary (set in send.split_at) should be removed when splitting overlong messages (see send.overlong)") + BotConfig.register BotConfigStringValue.new('send.truncate_text', + :default => "#{Reverse}...#{Reverse}", + :on_change => Proc.new { |bot, v| + bot.set_default_send_options :truncate_text => v.dup + }, + :desc => "When truncating overlong messages (see send.overlong) or when sending too many lines per message (see send.max_lines) replace the end of the last line with this text") + @argv = params[:argv] + unless FileTest.directory? Config::coredir + error "core directory '#{Config::coredir}' not found, did you setup.rb?" + exit 2 + end + unless FileTest.directory? Config::datadir error "data directory '#{Config::datadir}' not found, did you setup.rb?" exit 2 @@ -253,12 +322,24 @@ class IrcBot Dir.mkdir("#{botclass}/logs") unless File.exist?("#{botclass}/logs") Dir.mkdir("#{botclass}/registry") unless File.exist?("#{botclass}/registry") + Dir.mkdir("#{botclass}/safe_save") unless File.exist?("#{botclass}/safe_save") - @ping_timer = nil - @pong_timer = nil + # Time at which the last PING was sent @last_ping = nil + # Time at which the last line was RECV'd from the server + @last_rec = nil + @startup_time = Time.new - @config = BotConfig.new(self) + + begin + @config = BotConfig.configmanager + @config.bot_associate(self) + rescue => e + fatal e.inspect + fatal e.backtrace.join("\n") + log_session_end + exit 2 + end if @config['core.run_as_daemon'] $daemonize = true @@ -292,7 +373,7 @@ class IrcBot end def STDOUT.write(str=nil) log str, 2 - return str.to_s.length + return str.to_s.size end def STDERR.write(str=nil) if str.to_s.match(/:\d+: warning:/) @@ -300,7 +381,7 @@ class IrcBot else error str, 2 end - return str.to_s.length + return str.to_s.size end end @@ -316,39 +397,53 @@ class IrcBot @registry = BotRegistry.new self @timer = Timer::Timer.new(1.0) # only need per-second granularity - @timer.add(@config['core.save_every']) { save } if @config['core.save_every'] + @save_mutex = Mutex.new + if @config['core.save_every'] > 0 + @save_timer = @timer.add(@config['core.save_every']) { save } + else + @save_timer = nil + end + @quit_mutex = Mutex.new @logs = Hash.new - @httputil = Utils::HttpUtil.new(self) - - @lang = Language::Language.new(@config['core.language']) - - @keywords = Keywords.new(self) + @plugins = nil + @lang = Language::Language.new(self, @config['core.language']) begin - @auth = IrcAuth.new(self) + @auth = Auth::authmanager + @auth.bot_associate(self) + # @auth.load("#{botclass}/botusers.yaml") rescue => e fatal e.inspect fatal e.backtrace.join("\n") log_session_end exit 2 end + @auth.everyone.set_default_permission("*", true) + @auth.botowner.password= @config['auth.password'] Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins") - @plugins = Plugins::Plugins.new(self, ["#{botclass}/plugins"]) + @plugins = Plugins::pluginmanager + @plugins.bot_associate(self) + @plugins.add_botmodule_dir(Config::coredir + "/utils") + @plugins.add_botmodule_dir(Config::coredir) + @plugins.add_botmodule_dir("#{botclass}/plugins") + @plugins.add_botmodule_dir(Config::datadir + "/plugins") + @plugins.scan + + Utils.set_safe_save_dir("#{botclass}/safe_save") + @httputil = Utils::HttpUtil.new(self) - @socket = IrcSocket.new(@config['server.name'], @config['server.port'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst']) + + @socket = IrcSocket.new(@config['server.name'], @config['server.port'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'], :ssl => @config['server.ssl']) @client = IrcClient.new - @server = @client.server - @myself = @client.client - @myself.nick = @config['irc.nick'] # Channels where we are quiet - # It's nil when we are not quiet, an empty list when we are quiet - # in all channels, a list of channels otherwise - @quiet = nil - + # Array of channels names where the bot should be quiet + # '*' means all channels + # + @quiet = [] @client[:welcome] = proc {|data| irclog "joined server #{@client.server} as #{myself}", "server" @@ -364,26 +459,51 @@ class IrcBot end } } + + # TODO the next two @client should go into rfc2812.rb, probably + # Since capabs are two-steps processes, server.supports[:capab] + # should be a three-state: nil, [], [....] + asked_for = { :"identify-msg" => false } @client[:isupport] = proc { |data| - # TODO this needs to go into rfc2812.rb - # Since capabs are two-steps processes, server.supports[:capab] - # should be a three-state: nil, [], [....] - sendq "CAPAB IDENTIFY-MSG" if @server.supports[:capab] + if server.supports[:capab] and !asked_for[:"identify-msg"] + sendq "CAPAB IDENTIFY-MSG" + asked_for[:"identify-msg"] = true + end } @client[:datastr] = proc { |data| - # TODO this needs to go into rfc2812.rb if data[:text] == "IDENTIFY-MSG" - @server.capabilities["identify-msg".to_sym] = true + server.capabilities[:"identify-msg"] = true else debug "Not handling RPL_DATASTR #{data[:servermessage]}" end } + @client[:privmsg] = proc { |data| - message = PrivMessage.new(self, @server, data[:source], data[:target], data[:message]) - onprivmsg(message) + m = PrivMessage.new(self, server, data[:source], data[:target], data[:message]) + # debug "Message source is #{data[:source].inspect}" + # debug "Message target is #{data[:target].inspect}" + # debug "Bot is #{myself.inspect}" + + ignored = false + @config['irc.ignore_users'].each { |mask| + if m.source.matches?(server.new_netmask(mask)) + ignored = true + break + end + } + + irclogprivmsg(m) + + unless ignored + @plugins.delegate "listen", m + @plugins.privmsg(m) if m.address? + if not m.replied + @plugins.delegate "unreplied", m + end + end } @client[:notice] = proc { |data| - message = NoticeMessage.new(self, @server, data[:source], data[:target], data[:message]) + message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message]) # pass it off to plugins that want to hear everything @plugins.delegate "listen", message } @@ -393,14 +513,22 @@ class IrcBot } } @client[:nicktaken] = proc { |data| - nickchg "#{data[:nick]}_" + new = "#{data[:nick]}_" + nickchg new + # If we're setting our nick at connection because our choice was taken, + # we have to fix our nick manually, because there will be no NICK message + # yo inform us that our nick has been changed. + if data[:target] == '*' + debug "setting my connection nick to #{new}" + nick = new + end @plugins.delegate "nicktaken", data[:nick] } @client[:badnick] = proc {|data| - warning "bad nick (#{data[:nick]})" + arning "bad nick (#{data[:nick]})" } @client[:ping] = proc {|data| - @socket.queue "PONG #{data[:pingid]}" + sendq "PONG #{data[:pingid]}" } @client[:pong] = proc {|data| @last_ping = nil @@ -409,38 +537,49 @@ class IrcBot source = data[:source] old = data[:oldnick] new = data[:newnick] - m = NickMessage.new(self, @server, source, old, new) + m = NickMessage.new(self, server, source, old, new) if source == myself debug "my nick is now #{new}" end data[:is_on].each { |ch| - irclog "@ #{data[:old]} is now known as #{data[:new]}", ch + irclog "@ #{old} is now known as #{new}", ch } @plugins.delegate("listen", m) @plugins.delegate("nick", m) } @client[:quit] = proc {|data| - m = QuitMessage.new(self, @server, data[:source], data[:source], data[:message]) + source = data[:source] + message = data[:message] + m = QuitMessage.new(self, server, source, source, message) data[:was_on].each { |ch| - irclog "@ Quit: #{sourcenick}: #{message}", ch + irclog "@ Quit: #{source}: #{message}", ch } @plugins.delegate("listen", m) @plugins.delegate("quit", m) } @client[:mode] = proc {|data| - irclog "@ Mode #{data[:modestring]} by #{data[:sourcenick]}", data[:channel] + irclog "@ Mode #{data[:modestring]} by #{data[:source]}", data[:channel] } @client[:join] = proc {|data| - m = JoinMessage.new(self, @server, data[:source], data[:channel], data[:message]) - onjoin(m) + m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message]) + irclogjoin(m) + + @plugins.delegate("listen", m) + @plugins.delegate("join", m) } @client[:part] = proc {|data| - m = PartMessage.new(self, @server, data[:source], data[:channel], data[:message]) - onpart(m) + m = PartMessage.new(self, server, data[:source], data[:channel], data[:message]) + irclogpart(m) + + @plugins.delegate("listen", m) + @plugins.delegate("part", m) } @client[:kick] = proc {|data| - m = KickMessage.new(self, @server, data[:source], data[:target], data[:channel],data[:message]) - onkick(m) + m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message]) + irclogkick(m) + + @plugins.delegate("listen", m) + @plugins.delegate("kick", m) } @client[:invite] = proc {|data| if data[:target] == myself @@ -448,23 +587,23 @@ class IrcBot end } @client[:changetopic] = proc {|data| - channel = data[:channel] - source = data[:source] - topic = data[:topic] - if source == myself - irclog "@ I set topic \"#{topic}\"", channel - else - irclog "@ #{source} set topic \"#{topic}\"", channel - end - m = TopicMessage.new(self, @server, data[:source], data[:channel], data[:topic]) + m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic]) + irclogtopic(m) - ontopic(m) @plugins.delegate("listen", m) @plugins.delegate("topic", m) } - @client[:topic] = @client[:topicinfo] = proc { |data| - m = TopicMessage.new(self, @server, data[:source], data[:channel], data[:channel].topic) - ontopic(m) + @client[:topic] = proc { |data| + irclog "@ Topic is \"#{data[:topic]}\"", data[:channel] + } + @client[:topicinfo] = proc { |data| + channel = data[:channel] + topic = channel.topic + irclog "@ Topic set by #{topic.set_by} on #{topic.set_on}", channel + m = TopicMessage.new(self, server, data[:source], channel, topic) + + @plugins.delegate("listen", m) + @plugins.delegate("topic", m) } @client[:names] = proc { |data| @plugins.delegate "names", data[:channel], data[:users] @@ -473,28 +612,55 @@ class IrcBot #debug "UNKNOWN: #{data[:serverstring]}" irclog data[:serverstring], ".unknown" } + + set_default_send_options :newlines => @config['send.newlines'].to_sym, + :join_with => @config['send.join_with'].dup, + :max_lines => @config['send.max_lines'], + :overlong => @config['send.overlong'].to_sym, + :split_at => Regexp.new(@config['send.split_at']), + :purge_split => @config['send.purge_split'], + :truncate_text => @config['send.truncate_text'].dup end + def set_default_send_options(opts={}) + # Default send options for NOTICE and PRIVMSG + unless defined? @default_send_options + @default_send_options = { + :queue_channel => nil, # use default queue channel + :queue_ring => nil, # use default queue ring + :newlines => :split, # or :join + :join_with => ' ', # by default, use a single space + :max_lines => 0, # maximum number of lines to send with a single command + :overlong => :split, # or :truncate + # TODO an array of splitpoints would be preferrable for this option: + :split_at => /\s+/, # by default, split overlong lines at whitespace + :purge_split => true, # should the split string be removed? + :truncate_text => "#{Reverse}...#{Reverse}" # text to be appened when truncating + } + end + @default_send_options.update opts unless opts.empty? + end + # checks if we should be quiet on a channel def quiet_on?(channel) - return false unless @quiet - return true if @quiet.empty? - return @quiet.include?(channel.to_s) + return @quiet.include?('*') || @quiet.include?(channel.downcase) end - def set_quiet(channel=nil) + def set_quiet(channel) if channel - @quiet << channel.to_s unless @quiet.include?(channel.to_s) + ch = channel.downcase.dup + @quiet << ch unless @quiet.include?(ch) else - @quiet = [] + @quiet.clear + @quiet << '*' end end - def reset_quiet(channel=nil) + def reset_quiet(channel) if channel - @quiet.delete_if { |x| x == channel.to_s } + @quiet.delete channel.downcase else - @quiet = nil + @quiet.clear end end @@ -502,14 +668,12 @@ class IrcBot def got_sig(sig) debug "received #{sig}, queueing quit" $interrupted += 1 + quit unless @quit_mutex.locked? debug "interrupted #{$interrupted} times" - if $interrupted >= 5 + if $interrupted >= 3 debug "drastic!" log_session_end exit 2 - elsif $interrupted >= 3 - debug "quitting" - quit end end @@ -530,25 +694,36 @@ class IrcBot rescue => e raise e.class, "failed to connect to IRC server at #{@config['server.name']} #{@config['server.port']}: " + e end + quit if $interrupted > 0 @socket.emergency_puts "PASS " + @config['server.password'] if @config['server.password'] - @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@config['server.name']} :Ruby bot. (c) Tom Gilbert" - start_server_pings + @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@config['server.name']} :Ruby bot. (c) Tom Gilbert and the rbot development team" + quit if $interrupted > 0 + myself.nick = @config['irc.nick'] + myself.user = @config['irc.user'] end # begin event handling loop def mainloop while true begin - quit if $interrupted > 0 + quit if $interrupted > 0 connect @timer.start while @socket.connected? - if @socket.select + quit if $interrupted > 0 + + # Wait for messages and process them as they arrive. If nothing is + # received, we call the ping_server() method that will PING the + # server if appropriate, or raise a TimeoutError if no PONG has been + # received in the user-chosen timeout since the last PING sent. + if @socket.select(1) break unless reply = @socket.gets + @last_rec = Time.now @client.process reply + else + ping_server end - quit if $interrupted > 0 end # I despair of this. Some of my users get "connection reset by peer" @@ -557,7 +732,7 @@ class IrcBot rescue SystemExit log_session_end exit 0 - rescue Errno::ETIMEDOUT, TimeoutError, SocketError => e + rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e error "network exception: #{e.class}: #{e}" debug e.backtrace.join("\n") rescue BDB::Fatal => e @@ -579,7 +754,7 @@ class IrcBot end stop_server_pings - @server.clear + server.clear if @socket.connected? @socket.clearq @socket.shutdown @@ -601,109 +776,162 @@ class IrcBot # 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, chan=nil, ring=0) - # limit it according to the byterate, splitting the message - # taking into consideration the actual message length - # and all the extra stuff - # TODO allow something to do for commands that produce too many messages - # TODO example: math 10**10000 - left = @socket.bytes_per - type.length - where.to_s.length - 4 - begin - if(left >= message.length) - sendq "#{type} #{where} :#{message}", chan, ring - 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}", chan, ring - log_sent(type, where, line) - end while(message.length > 0) - end + def sendmsg(type, where, original_message, options={}) + opts = @default_send_options.merge(options) - # queue an arbitraty message for the server - def sendq(message="", chan=nil, ring=0) - # temporary - @socket.queue(message, chan, ring) - end - - # send a notice message to channel/nick +where+ - def notice(where, message, mchan="", mring=-1) - if mchan == "" - chan = where - else + # For starters, set up appropriate queue channels and rings + mchan = opts[:queue_channel] + mring = opts[:queue_ring] + if mchan chan = mchan + else + chan = where end - if mring < 0 + if mring + ring = mring + else case where when User ring = 1 else ring = 2 end - else - ring = mring end - message.each_line { |line| - line.chomp! - next unless(line.length > 0) - sendmsg "NOTICE", where, line, chan, ring - } - end - # say something (PRIVMSG) to channel/nick +where+ - def say(where, message, mchan="", mring=-1) - if mchan == "" - chan = where + message = original_message.to_s.gsub(/[\r\n]+/, "\n") + case opts[:newlines] + when :join + lines = [message.gsub("\n", opts[:join_with])] + when :split + lines = Array.new + message.each_line { |line| + line.chomp! + next unless(line.size > 0) + lines << line + } else - chan = mchan + raise "Unknown :newlines option #{opts[:newlines]} while sending #{original_message.inspect}" end - if mring < 0 - case where - when User - ring = 1 - else - ring = 2 - end + + # The IRC protocol requires that each raw message must be not longer + # than 512 characters. From this length with have to subtract the EOL + # terminators (CR+LF) and the length of ":botnick!botuser@bothost " + # that will be prepended by the server to all of our messages. + + # The maximum raw message length we can send is therefore 512 - 2 - 2 + # minus the length of our hostmask. + + max_len = 508 - myself.fullform.size + + # On servers that support IDENTIFY-MSG, we have to subtract 1, because messages + # will have a + or - prepended + if server.capabilities[:"identify-msg"] + max_len -= 1 + end + + # When splitting the message, we'll be prefixing the following string: + # (e.g. "PRIVMSG #rbot :") + fixed = "#{type} #{where} :" + + # And this is what's left + left = max_len - fixed.size + + case opts[:overlong] + when :split + truncate = false + split_at = opts[:split_at] + when :truncate + truncate = opts[:truncate_text] + truncate = @default_send_options[:truncate_text] if truncate.size > left + truncate = "" if truncate.size > left else - ring = mring + raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}" end - message.to_s.gsub(/[\r\n]+/, "\n").each_line { |line| - line.chomp! - next unless(line.length > 0) - unless quiet_on?(where) - sendmsg "PRIVMSG", where, line, chan, ring - end + + # Counter to check the number of lines sent by this command + cmd_lines = 0 + max_lines = opts[:max_lines] + maxed = false + line = String.new + lines.each { |msg| + begin + if max_lines > 0 and cmd_lines == max_lines - 1 + truncate = opts[:truncate_text] + truncate = @default_send_options[:truncate_text] if truncate.size > left + truncate = "" if truncate.size > left + maxed = true + end + if(left >= msg.size) and not maxed + sendq "#{fixed}#{msg}", chan, ring + log_sent(type, where, msg) + cmd_lines += 1 + break + end + if truncate + line.replace msg.slice(0, left-truncate.size) + # line.sub!(/\s+\S*$/, truncate) + line << truncate + raise "PROGRAMMER ERROR! #{line.inspect} of size #{line.size} > #{left}" if line.size > left + sendq "#{fixed}#{line}", chan, ring + log_sent(type, where, line) + return + end + line.replace msg.slice!(0, left) + lastspace = line.rindex(opts[:split_at]) + if(lastspace) + msg.replace line.slice!(lastspace, line.size) + msg + msg.gsub!(/^#{opts[:split_at]}/, "") if opts[:purge_split] + end + sendq "#{fixed}#{line}", chan, ring + log_sent(type, where, line) + cmd_lines += 1 + end while(msg.size > 0) } end + # queue an arbitraty message for the server + def sendq(message="", chan=nil, ring=0) + # temporary + @socket.queue(message, chan, ring) + end + + # send a notice message to channel/nick +where+ + def notice(where, message, options={}) + return if where.kind_of?(Channel) and quiet_on?(where) + sendmsg "NOTICE", where, message, options + end + + # say something (PRIVMSG) to channel/nick +where+ + def say(where, message, options={}) + return if where.kind_of?(Channel) and quiet_on?(where) + sendmsg "PRIVMSG", where, message, options + end + # perform a CTCP action with message +message+ to channel/nick +where+ - def action(where, message, mchan="", mring=-1) - if mchan == "" - chan = where - else + def action(where, message, options={}) + return if where.kind_of?(Channel) and quiet_on?(where) + mchan = options.fetch(:queue_channel, nil) + mring = options.fetch(:queue_ring, nil) + if mchan chan = mchan + else + chan = where end - if mring < 0 + if mring + ring = mring + else case where - when Channel - ring = 2 - else + when User ring = 1 + else + ring = 2 end - else - ring = mring end + # FIXME doesn't check message length. Can we make this exploit sendmsg? sendq "PRIVMSG #{where} :\001ACTION #{message}\001", chan, ring case where when Channel irclog "* #{myself} #{message}", where - when User - irclog "* #{myself}[#{where}] #{message}", $1 else irclog "* #{myself}[#{where}] #{message}", where end @@ -719,7 +947,7 @@ class IrcBot def irclog(message, where="server") message = message.chomp stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S") - where = where.to_s.gsub(/[:!?$*()\/\\<>|"']/, "_") + where = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_") unless(@logs.has_key?(where)) @logs[where] = File.new("#{@botclass}/logs/#{where}", "a") @logs[where].sync = true @@ -735,39 +963,43 @@ class IrcBot # disconnect from the server and cleanup all plugins and modules def shutdown(message = nil) - debug "Shutting down ..." - ## No we don't restore them ... let everything run through - # begin - # trap("SIGINT", "DEFAULT") - # trap("SIGTERM", "DEFAULT") - # trap("SIGHUP", "DEFAULT") - # rescue => e - # debug "failed to restore signals: #{e.inspect}\nProbably running on windows?" - # end - message = @lang.get("quit") if (message.nil? || message.empty?) - if @socket.connected? - debug "Clearing socket" - @socket.clearq - debug "Sending quit message" - @socket.emergency_puts "QUIT :#{message}" - debug "Flushing socket" - @socket.flush - debug "Shutting down socket" - @socket.shutdown + @quit_mutex.synchronize do + debug "Shutting down ..." + ## No we don't restore them ... let everything run through + # begin + # trap("SIGINT", "DEFAULT") + # trap("SIGTERM", "DEFAULT") + # trap("SIGHUP", "DEFAULT") + # rescue => e + # debug "failed to restore signals: #{e.inspect}\nProbably running on windows?" + # end + message = @lang.get("quit") if (message.nil? || message.empty?) + if @socket.connected? + debug "Clearing socket" + @socket.clearq + debug "Sending quit message" + @socket.emergency_puts "QUIT :#{message}" + debug "Flushing socket" + @socket.flush + debug "Shutting down socket" + @socket.shutdown + end + debug "Logging quits" + server.channels.each { |ch| + irclog "@ quit (#{message})", ch + } + debug "Saving" + save + debug "Cleaning up" + @save_mutex.synchronize do + @plugins.cleanup + end + # debug "Closing registries" + # @registry.close + debug "Cleaning up the db environment" + DBTree.cleanup_env + log "rbot quit (#{message})" end - debug "Logging quits" - @server.channels.each { |ch| - irclog "@ quit (#{message})", ch - } - debug "Saving" - save - debug "Cleaning up" - @plugins.cleanup - # debug "Closing registries" - # @registry.close - debug "Cleaning up the db environment" - DBTree.cleanup_env - log "rbot quit (#{message})" end # message:: optional IRC quit message @@ -790,20 +1022,20 @@ class IrcBot exec($0, *@argv) end - # call the save method for bot's config, keywords, auth and all plugins + # call the save method for all of the botmodules def save - @config.save - @keywords.save - @auth.save - @plugins.save - DBTree.cleanup_logs + @save_mutex.synchronize do + @plugins.save + DBTree.cleanup_logs + end end - # call the rescan method for the bot's lang, keywords and all plugins + # call the rescan method for all of the botmodules def rescan - @lang.rescan - @plugins.rescan - @keywords.rescan + @save_mutex.synchronize do + @lang.rescan + @plugins.rescan + end end # channel:: channel to join @@ -824,12 +1056,17 @@ class IrcBot # attempt to change bot's nick to +name+ def nickchg(name) - sendq "NICK #{name}" + sendq "NICK #{name}" end # changing mode def mode(channel, mode, target) - sendq "MODE #{channel} #{mode} #{target}", channel, 2 + sendq "MODE #{channel} #{mode} #{target}", channel, 2 + end + + # kicking a user + def kick(channel, user, msg) + sendq "KICK #{channel} #{user} :#{msg}", channel, 2 end # m:: message asking for help @@ -839,21 +1076,9 @@ class IrcBot topic = nil if topic == "" case topic when nil - helpstr = "help topics: core, auth, keywords" + helpstr = "help topics: " helpstr += @plugins.helptopics helpstr += " (help 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}" @@ -870,91 +1095,39 @@ class IrcBot return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@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 - stop_server_pings - 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.queue "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 - rescue - debug "couldn't shutdown connection (already shutdown?)" - end - @last_ping = nil + # We want to respond to a hung server in a timely manner. If nothing was received + # in the user-selected timeout and we haven't PINGed the server yet, we PING + # the server. If the PONG is not received within the user-defined timeout, we + # assume we're in ping timeout and act accordingly. + def ping_server + act_timeout = @config['server.ping_timeout'] + return if act_timeout <= 0 + now = Time.now + if @last_rec && now > @last_rec + act_timeout + if @last_ping.nil? + # No previous PING pending, send a new one + sendq "PING :rbot" + @last_ping = Time.now + else + diff = now - @last_ping + if diff > act_timeout + debug "no PONG from server in #{diff} seconds, reconnecting" + # the actual reconnect is handled in the main loop: raise TimeoutError, "no PONG from server in #{diff} seconds" end end - } + end end def stop_server_pings + # cancel previous PINGs and reset time of last RECV @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 + @last_rec = nil end private - # handle help requests for "core" topics - def corehelp(topic="") - case topic - when "quit" - return "quit [] => quit IRC with message " - when "restart" - return "restart => completely stop and restart the bot (including reconnect)" - when "join" - return "join [] => join channel with secret key if specified. #{myself} also responds to invites if you have the required access level" - when "part" - return "part => part 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 => attempt to change nick to " - when "say" - return "say | => say to or in private message to " - when "action" - return "action | => does a /me to or in private message to " - # when "topic" - # return "topic => set topic of to " - when "quiet" - return "quiet [in here|] => with no arguments, stop speaking in all channels, if \"in here\", stop speaking in this channel, or stop speaking in " - when "talk" - return "talk [in here|] => with no arguments, resume speaking in all channels, if \"in here\", resume speaking in this channel, or resume speaking in " - when "version" - return "version => describes software version" - when "botsnack" - return "botsnack => reward #{myself} for being good" - when "hello" - return "hello|hi|hey|yo [#{myself}] => 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 + def irclogprivmsg(m) if(m.action?) if(m.private?) irclog "* [#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick @@ -968,115 +1141,6 @@ class IrcBot irclog "[#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick end end - - @config['irc.ignore_users'].each { |mask| return if Irc.netmaskmatch(mask,m.source) } - - # 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" - irclog "@ #{m.sourcenick} pinged me" - return - end - - if(m.address?) - delegate_privmsg(m) - 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(?:\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) - 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.reply "saving ..." - save - m.reply "rescanning ..." - rescan - m.reply "done. #{@plugins.status(true)}" - end - when (/^quiet$/i) - if(auth.allow?("talk", m.source, m.replyto)) - m.okay - set_quiet - 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? - set_quiet(where) - end - when (/^talk$/i) - if(auth.allow?("talk", m.source, m.replyto)) - reset_quiet - 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? - reset_quiet(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?) - end - else - # stuff to handle when not addressed - case m.message - when (/^\s*(hello|howdy|hola|salut|bonjour|sup|niihau|hey|hi|yo(\W|$))[\s,-.]+#{Regexp.escape(self.nick)}$/i) - say m.replyto, @lang.get("hello_X") % m.sourcenick - when (/^#{Regexp.escape(self.nick)}!*$/) - say m.replyto, @lang.get("hello_X") % m.sourcenick - else - @keywords.privmsg(m) - end - end end # log a message. Internal use only. @@ -1086,71 +1150,54 @@ class IrcBot case where when Channel irclog "-=#{myself}=- #{message}", where - when User - irclog "[-=#{where}=-] #{message}", $1 else - irclog "[-=#{where}=-] #{message}", where + irclog "[-=#{where}=-] #{message}", where end when "PRIVMSG" case where when Channel irclog "<#{myself}> #{message}", where - when User - irclog "[msg(#{where})] #{message}", $1 else irclog "[msg(#{where})] #{message}", where end end end - def onjoin(m) + def irclogjoin(m) if m.address? debug "joined channel #{m.channel}" irclog "@ Joined channel #{m.channel}", m.channel else irclog "@ #{m.sourcenick} joined channel #{m.channel}", m.channel end - - @plugins.delegate("listen", m) - @plugins.delegate("join", m) end - def onpart(m) + def irclogpart(m) if(m.address?) debug "left channel #{m.channel}" irclog "@ Left channel #{m.channel} (#{m.message})", m.channel else irclog "@ #{m.sourcenick} left channel #{m.channel} (#{m.message})", m.channel end - - # delegate to plugins - @plugins.delegate("listen", m) - @plugins.delegate("part", m) end - # respond to being kicked from a channel - def onkick(m) + def irclogkick(m) if(m.address?) debug "kicked from channel #{m.channel}" irclog "@ You have been kicked from #{m.channel} by #{m.sourcenick} (#{m.message})", m.channel else irclog "@ #{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) - debug "topic of channel #{m.channel} is now #{m.topic}" + def irclogtopic(m) + if m.source == myself + irclog "@ I set topic \"#{m.topic}\"", m.channel + else + irclog "@ #{m.source} set topic \"#{m.topic}\"", m.channel + end 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