X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fircbot.rb;h=619150fbf6d591552ede4c52af6ba4db28073b8f;hb=42045b5df29519cb4307ac433c6fd0d4ba5f157b;hp=c87b909b92326e86cd79f4ab053543f5227f6dc4;hpb=823ef85bd8f6b4554f8d44e13b5620da8ae64304;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/ircbot.rb b/lib/rbot/ircbot.rb index c87b909b..619150fb 100644 --- a/lib/rbot/ircbot.rb +++ b/lib/rbot/ircbot.rb @@ -88,8 +88,9 @@ 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,12 @@ 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 plugins. 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| @@ -248,7 +257,7 @@ class IrcBot }, :desc => "String used to replace newlines when send.newlines is set to join") BotConfig.register BotConfigIntegerValue.new('send.max_lines', - :default => 0, + :default => 5, :validate => Proc.new { |v| v >= 0 }, :on_change => Proc.new { |bot, v| bot.set_default_send_options :max_lines => v @@ -424,20 +433,24 @@ 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 + "/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) + 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.list'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'], :ssl => @config['server.ssl']) + @client = Client.new - @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 + @plugins.scan # Channels where we are quiet # Array of channels names where the bot should be quiet @@ -513,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 + # to 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]}" @@ -526,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] @@ -614,6 +637,18 @@ class IrcBot :truncate_text => @config['send.truncate_text'].dup end + 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 @@ -684,11 +719,15 @@ 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'] @@ -702,6 +741,7 @@ class IrcBot connect @timer.start + quit_msg = nil while @socket.connected? quit if $interrupted > 0 @@ -727,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") @@ -738,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") @@ -745,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 @@ -790,16 +827,16 @@ class IrcBot end end - message = original_message.to_s.gsub(/[\r\n]+/, "\n") + multi_line = original_message.to_s.gsub(/[\r\n]+/, "\n") + messages = Array.new case opts[:newlines] when :join - lines = [message.gsub("\n", opts[:join_with])] + messages << [multi_line.gsub("\n", opts[:join_with])] when :split - lines = Array.new - message.each_line { |line| + multi_line.each_line { |line| line.chomp! next unless(line.size > 0) - lines << line + messages << line } else raise "Unknown :newlines option #{opts[:newlines]} while sending #{original_message.inspect}" @@ -828,56 +865,47 @@ class IrcBot # 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 + truncate = opts[:truncate_text] + truncate = @default_send_options[:truncate_text] if truncate.size > left + truncate = "" if truncate.size > left + + all_lines = messages.map { |line| + if line.size < left + line + else + case opts[:overlong] + when :split + msg = line.dup + sub_lines = Array.new + begin + sub_lines << msg.slice!(0, left) + break if msg.empty? + lastspace = sub_lines.last.rindex(opts[:split_at]) + if lastspace + msg.replace sub_lines.last.slice!(lastspace, sub_lines.last.size) + msg + msg.gsub!(/^#{opts[:split_at]}/, "") if opts[:purge_split] + end + end until msg.empty? + sub_lines + when :truncate + line.slice(0, left - truncate.size) << truncate + else + raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}" + end + end + }.flatten + + if opts[:max_lines] > 0 and all_lines.length > opts[:max_lines] + lines = all_lines[0...opts[:max_lines]] + new_last = lines.last.slice(0, left - truncate.size) << truncate + lines.last.replace(new_last) else - raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}" + lines = all_lines 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) + lines.each { |line| + sendq "#{fixed}#{line}", chan, ring + log_sent(type, where, line) } end @@ -939,12 +967,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 + unless(@logs.has_key?(where_str)) + @logs[where_str] = File.new("#{@botclass}/logs/#{where_str}", "a") + @logs[where_str].sync = true end - @logs[where].puts "[#{stamp}] #{message}" + @logs[where_str].puts "[#{stamp}] #{message}" #debug "[#{stamp}] <#{where}> #{message}" end @@ -953,6 +985,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 @@ -965,21 +1017,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" @@ -1122,15 +1160,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 @@ -1160,7 +1198,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 @@ -1169,16 +1207,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