X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fircbot.rb;h=54782f70673722f2f73edc96dc08eb1034c3987f;hb=12906a51f698aebe1c9a5e19b15555ebbbcc4368;hp=956415f95476cd27d478c5ce62421191f666e53e;hpb=7f4e98a691ba6ee6f220fec982f17c900c929f1d;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/ircbot.rb b/lib/rbot/ircbot.rb index 956415f9..54782f70 100644 --- a/lib/rbot/ircbot.rb +++ b/lib/rbot/ircbot.rb @@ -69,7 +69,7 @@ $interrupted = 0 # these first require 'rbot/rbotconfig' require 'rbot/config' -require 'rbot/utils' +# require 'rbot/utils' require 'rbot/irc' require 'rbot/rfc2812' @@ -82,14 +82,15 @@ require 'rbot/message' require 'rbot/language' require 'rbot/dbhash' require 'rbot/registry' -require 'rbot/httputil' +# 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 IrcAuth data +class Bot + COPYRIGHT_NOTICE = "(c) Tom Gilbert and the rbot development team" + # the bot's Auth data attr_reader :auth # the bot's BotConfig data @@ -123,7 +124,7 @@ class IrcBot # bot's httputil help object, for fetching resources via http. Sets up # proxies etc as defined by the bot configuration/environment - attr_reader :httputil + attr_accessor :httputil # server we are connected to # TODO multiserver @@ -134,7 +135,7 @@ class IrcBot # bot User in the client/server connection # TODO multiserver def myself - @client.client + @client.user end # bot User in the client/server connection @@ -142,18 +143,14 @@ class IrcBot myself.nick end - # create a new IrcBot with botclass +botclass+ + # create a new Bot with botclass +botclass+ def initialize(botclass, params = {}) # BotConfig for the core bot # TODO should we split socket stuff into ircsocket, etc? - 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 BotConfigArrayValue.new('server.list', + :default => ['irc://localhost'], :wizard => true, + :requires_restart => true, + :desc => "List of irc servers rbot should try to connect to. Use comma to separate values. Servers are in format 'server.doma.in:port'. If port is not specified, default value (6667) is used.") BotConfig.register BotConfigBooleanValue.new('server.ssl', :default => false, :requires_restart => true, :wizard => true, :desc => "Use SSL to connect to this server?") @@ -183,6 +180,12 @@ class IrcBot 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.name', + :default => "Ruby bot", :requires_restart => true, + :desc => "IRC realname the bot should use") + BotConfig.register BotConfigBooleanValue.new('irc.name_copyright', + :default => true, :requires_restart => true, + :desc => "Append copyright notice to bot realname? (please don't disable unless it's really necessary)") BotConfig.register BotConfigStringValue.new('irc.user', :default => "rbot", :requires_restart => true, :desc => "local user the bot should appear to be", :wizard => true) @@ -235,6 +238,56 @@ class IrcBot :validate => Proc.new { |v| v > 0 }, :desc => "Maximum console messages logfile size (in megabytes)") + BotConfig.register BotConfigArrayValue.new('plugins.path', + :wizard => true, :default => ['(default)', '(default)/games', '(default)/contrib'], + :requires_restart => false, + :on_change => Proc.new { |bot, v| bot.setup_plugins_path }, + :desc => "Where the bot should look for plugin. List multiple directories using commas to separate. Use '(default)' for default prepackaged plugins collection, '(default)/contrib' for prepackaged unsupported plugins collection") + + 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 @@ -279,7 +332,6 @@ 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") - Utils.set_safe_save_dir("#{botclass}/safe_save") # Time at which the last PING was sent @last_ping = nil @@ -330,7 +382,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:/) @@ -338,7 +390,7 @@ class IrcBot else error str, 2 end - return str.to_s.length + return str.to_s.size end end @@ -364,8 +416,6 @@ class IrcBot @logs = Hash.new - @httputil = Utils::HttpUtil.new(self) - @plugins = nil @lang = Language::Language.new(self, @config['core.language']) @@ -383,21 +433,30 @@ class IrcBot @auth.botowner.password= @config['auth.password'] Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins") - @plugins = Plugins::pluginmanager + @plugins = Plugins::manager @plugins.bot_associate(self) - @plugins.add_botmodule_dir(Config::coredir) - @plugins.add_botmodule_dir("#{botclass}/plugins") - @plugins.add_botmodule_dir(Config::datadir + "/plugins") - @plugins.scan + setup_plugins_path() + + if @config['server.name'] + debug "upgrading configuration (server.name => server.list)" + srv_uri = 'irc://' + @config['server.name'] + srv_uri += ":#{@config['server.port']}" if @config['server.port'] + @config.items['server.list'.to_sym].set_string(srv_uri) + @config.delete('server.name'.to_sym) + @config.delete('server.port'.to_sym) + debug "server.list is now #{@config['server.list'].inspect}" + end - @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 - myself.nick = @config['irc.nick'] + @socket = IrcSocket.new(@config['server.list'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'], :ssl => @config['server.ssl']) + @client = Client.new + + @plugins.scan # 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" @@ -451,6 +510,9 @@ class IrcBot 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| @@ -464,11 +526,19 @@ 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| sendq "PONG #{data[:pingid]}" @@ -477,6 +547,8 @@ class IrcBot @last_ping = nil } @client[:nick] = proc {|data| + # debug "Message source is #{data[:source].inspect}" + # debug "Bot is #{myself.inspect}" source = data[:source] old = data[:oldnick] new = data[:newnick] @@ -556,48 +628,66 @@ class IrcBot irclog data[:serverstring], ".unknown" } - set_default_send_options + 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 - # Default send options for NOTICE and PRIVMSG - # TODO document, for plugin writers - # TODO some of these options, like :truncate_text and :max_lines, - # should be made into config variables that trigger this routine on change - @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 => nil, # 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 - } + def setup_plugins_path + @plugins.clear_botmodule_dirs + @plugins.add_botmodule_dir(Config::coredir + "/utils") + @plugins.add_botmodule_dir(Config::coredir) + @plugins.add_botmodule_dir("#{botclass}/plugins") + + @config['plugins.path'].each do |_| + path = _.sub(/^\(default\)/, Config::datadir + '/plugins') + @plugins.add_botmodule_dir(path) + end 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 @@ -629,12 +719,18 @@ class IrcBot quit if $interrupted > 0 @socket.connect rescue => e - raise e.class, "failed to connect to IRC server at #{@config['server.name']} #{@config['server.port']}: " + e + raise e.class, "failed to connect to IRC server at #{@socket.server_uri}: " + e end quit if $interrupted > 0 + + realname = @config['irc.name'].clone || 'Ruby bot' + realname << ' ' + COPYRIGHT_NOTICE if @config['irc.name_copyright'] + @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" + @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@socket.server_uri.host} :#{realname}" quit if $interrupted > 0 + myself.nick = @config['irc.nick'] + myself.user = @config['irc.user'] end # begin event handling loop @@ -645,6 +741,7 @@ class IrcBot connect @timer.start + quit_msg = nil while @socket.connected? quit if $interrupted > 0 @@ -670,6 +767,7 @@ class IrcBot rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e error "network exception: #{e.class}: #{e}" debug e.backtrace.join("\n") + quit_msg = e.to_s rescue BDB::Fatal => e fatal "fatal bdb error: #{e.class}: #{e}" fatal e.backtrace.join("\n") @@ -681,6 +779,7 @@ class IrcBot rescue Exception => e error "non-net exception: #{e.class}: #{e}" error e.backtrace.join("\n") + quit_msg = e.to_s rescue => e fatal "unexpected exception: #{e.class}: #{e}" fatal e.backtrace.join("\n") @@ -688,18 +787,13 @@ class IrcBot exit 2 end - stop_server_pings - server.clear - if @socket.connected? - @socket.clearq - @socket.shutdown - end + disconnect(quit_msg) - log "disconnected" + log "\n\nDisconnected\n\n" quit if $interrupted > 0 - log "waiting to reconnect" + log "\n\nWaiting to reconnect\n\n" sleep @config['server.reconnect_wait'] end end @@ -741,7 +835,7 @@ class IrcBot lines = Array.new message.each_line { |line| line.chomp! - next unless(line.length > 0) + next unless(line.size > 0) lines << line } else @@ -756,7 +850,7 @@ class IrcBot # The maximum raw message length we can send is therefore 512 - 2 - 2 # minus the length of our hostmask. - max_len = 508 - myself.fullform.length + max_len = 508 - myself.fullform.size # On servers that support IDENTIFY-MSG, we have to subtract 1, because messages # will have a + or - prepended @@ -769,7 +863,7 @@ class IrcBot fixed = "#{type} #{where} :" # And this is what's left - left = max_len - fixed.length + left = max_len - fixed.size case opts[:overlong] when :split @@ -777,8 +871,8 @@ class IrcBot split_at = opts[:split_at] when :truncate truncate = opts[:truncate_text] - truncate = @default_send_options[:truncate_text] if truncate.length > left - truncate = "" if truncate.length > left + truncate = @default_send_options[:truncate_text] if truncate.size > left + truncate = "" if truncate.size > left else raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}" end @@ -786,24 +880,27 @@ class IrcBot # 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(left >= msg.length) + 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) - return - end - if opts[:max_lines] and cmd_lines == max_lines - 1 - debug "Max lines count reached for message #{original_message.inspect} while sending #{msg.inspect}, truncating" - truncate = opts[:truncate_text] - truncate = @default_send_options[:truncate_text] if truncate.length > left - truncate = "" if truncate.length > left + cmd_lines += 1 + break end if truncate - line.replace msg.slice(0, left-truncate.length) - line.sub!(/\s+\S*$/, truncate) - raise "PROGRAMMER ERROR! #{line.inspect} of length #{line.length} > #{left}" if line.length > left + 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 @@ -811,13 +908,13 @@ class IrcBot line.replace msg.slice!(0, left) lastspace = line.rindex(opts[:split_at]) if(lastspace) - msg.replace line.slice!(lastspace, line.length) + msg + 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.length > 0) + cmd_lines += 1 + end while(msg.size > 0) } end @@ -829,20 +926,19 @@ class IrcBot # send a notice message to channel/nick +where+ def notice(where, message, options={}) - unless quiet_on?(where) - sendmsg "NOTICE", where, message, options - end + 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={}) - unless quiet_on?(where) - sendmsg "PRIVMSG", where, message, options - end + 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, 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 @@ -880,12 +976,16 @@ class IrcBot def irclog(message, where="server") message = message.chomp stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S") - where = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_") - unless(@logs.has_key?(where)) - @logs[where] = File.new("#{@botclass}/logs/#{where}", "a") - @logs[where].sync = true + if where.class <= Server + where_str = "server" + else + where_str = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_") end - @logs[where].puts "[#{stamp}] #{message}" + unless(@logs.has_key?(where_str)) + @logs[where_str] = File.new("#{@botclass}/logs/#{where_str}", "a") + @logs[where_str].sync = true + end + @logs[where_str].puts "[#{stamp}] #{message}" #debug "[#{stamp}] <#{where}> #{message}" end @@ -894,6 +994,26 @@ class IrcBot sendq "TOPIC #{where} :#{topic}", where, 2 end + def disconnect(message = nil) + 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 + } + stop_server_pings + @client.reset + end + # disconnect from the server and cleanup all plugins and modules def shutdown(message = nil) @quit_mutex.synchronize do @@ -906,21 +1026,7 @@ class IrcBot # 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 - } + disconnect debug "Saving" save debug "Cleaning up" @@ -1063,15 +1169,15 @@ class IrcBot def irclogprivmsg(m) if(m.action?) if(m.private?) - irclog "* [#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick + irclog "* [#{m.source}(#{m.sourceaddress})] #{m.message}", m.source else - irclog "* #{m.sourcenick} #{m.message}", m.target + irclog "* #{m.source} #{m.message}", m.target end else if(m.public?) - irclog "<#{m.sourcenick}> #{m.message}", m.target + irclog "<#{m.source}> #{m.message}", m.target else - irclog "[#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick + irclog "[#{m.source}(#{m.sourceaddress})] #{m.message}", m.source end end end @@ -1101,7 +1207,7 @@ class IrcBot debug "joined channel #{m.channel}" irclog "@ Joined channel #{m.channel}", m.channel else - irclog "@ #{m.sourcenick} joined channel #{m.channel}", m.channel + irclog "@ #{m.source} joined channel #{m.channel}", m.channel end end @@ -1110,16 +1216,16 @@ class IrcBot 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 + irclog "@ #{m.source} left channel #{m.channel} (#{m.message})", m.channel end end 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 + irclog "@ You have been kicked from #{m.channel} by #{m.source} (#{m.message})", m.channel else - irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.sourcenick} (#{m.message})", m.channel + irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.source} (#{m.message})", m.channel end end