X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fircbot.rb;h=9afdc46cf17a581be9a70b1dfd5aaacfa744b765;hb=014d7d1078fd070055db76a89cdfadb8f107541d;hp=98562d279a2b0cc4cbada544cbde8046245a9f92;hpb=bbf05f99728a39280a19d60cc428a40b2f094ce5;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/ircbot.rb b/lib/rbot/ircbot.rb index 98562d27..9afdc46c 100644 --- a/lib/rbot/ircbot.rb +++ b/lib/rbot/ircbot.rb @@ -1,3 +1,8 @@ +#-- vim:sw=2:et +#++ +# +# :title: rbot core + require 'thread' require 'etc' @@ -25,7 +30,10 @@ end class Exception def pretty_print(q) q.group(1, "#<%s: %s" % [self.class, self.message], ">") { - q.seplist(self.backtrace, lambda { "\n" }) { |v| v } if self.backtrace + if self.backtrace and not self.backtrace.empty? + q.text "\n" + q.seplist(self.backtrace, lambda { q.text "\n" } ) { |l| q.text l } + end } end end @@ -94,7 +102,7 @@ $interrupted = 0 require 'rbot/rbotconfig' require 'rbot/load-gettext' require 'rbot/config' -# require 'rbot/utils' +require 'rbot/config-compat' require 'rbot/irc' require 'rbot/rfc2812' @@ -102,12 +110,10 @@ require 'rbot/ircsocket' require 'rbot/botuser' require 'rbot/timer' require 'rbot/plugins' -# require 'rbot/channel' require 'rbot/message' require 'rbot/language' require 'rbot/dbhash' require 'rbot/registry' -# require 'rbot/httputil' module Irc @@ -115,10 +121,11 @@ module Irc # handles them or passes them to plugins, and contains core functionality. class Bot COPYRIGHT_NOTICE = "(c) Tom Gilbert and the rbot development team" + SOURCE_URL = "http://ruby-rbot.org" # the bot's Auth data attr_reader :auth - # the bot's BotConfig data + # the bot's Config data attr_reader :config # the botclass for this bot (determines configdir among other things) @@ -168,60 +175,92 @@ class Bot myself.nick end + # bot inspection + # TODO multiserver + def inspect + ret = self.to_s[0..-2] + ret << ' version=' << $version.inspect + ret << ' botclass=' << botclass.inspect + ret << ' lang="' << lang.language + if defined?(GetText) + ret << '/' << locale + end + ret << '"' + ret << ' nick=' << nick.inspect + ret << ' server=' + if server + ret << (server.to_s + (socket ? + ' [' << socket.server_uri.to_s << ']' : '')).inspect + unless server.channels.empty? + ret << " channels=" + ret << server.channels.map { |c| + "%s%s" % [c.modes_of(nick).map { |m| + server.prefix_for_mode(m) + }, c.name] + }.inspect + end + else + ret << '(none)' + end + ret << ' plugins=' << plugins.inspect + ret << ">" + end + + # create a new Bot with botclass +botclass+ def initialize(botclass, params = {}) - # BotConfig for the core bot + # Config for the core bot # TODO should we split socket stuff into ircsocket, etc? - BotConfig.register BotConfigArrayValue.new('server.list', + Config.register Config::ArrayValue.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', + Config.register Config::BooleanValue.new('server.ssl', :default => false, :requires_restart => true, :wizard => true, :desc => "Use SSL to connect to this server?") - BotConfig.register BotConfigStringValue.new('server.password', + Config.register Config::StringValue.new('server.password', :default => false, :requires_restart => true, :desc => "Password for connecting to this server (if required)", :wizard => true) - BotConfig.register BotConfigStringValue.new('server.bindhost', + Config.register Config::StringValue.new('server.bindhost', :default => false, :requires_restart => true, :desc => "Specific local host or IP for the bot to bind to (if required)", :wizard => true) - BotConfig.register BotConfigIntegerValue.new('server.reconnect_wait', + Config.register Config::IntegerValue.new('server.reconnect_wait', :default => 5, :validate => Proc.new{|v| v >= 0}, :desc => "Seconds to wait before attempting to reconnect, on disconnect") - BotConfig.register BotConfigFloatValue.new('server.sendq_delay', + Config.register Config::FloatValue.new('server.sendq_delay', :default => 2.0, :validate => Proc.new{|v| v >= 0}, :desc => "(flood prevention) the delay between sending messages to the server (in seconds)", :on_change => Proc.new {|bot, v| bot.socket.sendq_delay = v }) - BotConfig.register BotConfigIntegerValue.new('server.sendq_burst', + Config.register Config::IntegerValue.new('server.sendq_burst', :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 BotConfigIntegerValue.new('server.ping_timeout', + Config.register Config::IntegerValue.new('server.ping_timeout', :default => 30, :validate => Proc.new{|v| v >= 0}, :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", + Config.register Config::StringValue.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', + Config.register Config::StringValue.new('irc.name', :default => "Ruby bot", :requires_restart => true, :desc => "IRC realname the bot should use") - BotConfig.register BotConfigBooleanValue.new('irc.name_copyright', + Config.register Config::BooleanValue.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", + Config.register Config::StringValue.new('irc.user', :default => "rbot", :requires_restart => true, :desc => "local user the bot should appear to be", :wizard => true) - BotConfig.register BotConfigArrayValue.new('irc.join_channels', + Config.register Config::ArrayValue.new('irc.join_channels', :default => [], :wizard => true, :desc => "What channels the bot should always join at startup. List multiple channels using commas to separate. If a channel requires a password, use a space after the channel name. e.g: '#chan1, #chan2, #secretchan secritpass, #chan3'") - BotConfig.register BotConfigArrayValue.new('irc.ignore_users', + Config.register Config::ArrayValue.new('irc.ignore_users', :default => [], :desc => "Which users to ignore input from. This is mainly to avoid bot-wars triggered by creative people") - BotConfig.register BotConfigIntegerValue.new('core.save_every', + Config.register Config::IntegerValue.new('core.save_every', :default => 60, :validate => Proc.new{|v| v >= 0}, :on_change => Proc.new { |bot, v| if @save_timer @@ -240,73 +279,73 @@ class Bot }, :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', + Config.register Config::BooleanValue.new('core.run_as_daemon', :default => false, :requires_restart => true, :desc => "Should the bot run as a daemon?") - BotConfig.register BotConfigStringValue.new('log.file', + Config.register Config::StringValue.new('log.file', :default => false, :requires_restart => true, :desc => "Name of the logfile to which console messages will be redirected when the bot is run as a daemon") - BotConfig.register BotConfigIntegerValue.new('log.level', + Config.register Config::IntegerValue.new('log.level', :default => 1, :requires_restart => false, :validate => Proc.new { |v| (0..5).include?(v) }, :on_change => Proc.new { |bot, v| $logger.level = v }, :desc => "The minimum logging level (0=DEBUG,1=INFO,2=WARN,3=ERROR,4=FATAL) for console messages") - BotConfig.register BotConfigIntegerValue.new('log.keep', + Config.register Config::IntegerValue.new('log.keep', :default => 1, :requires_restart => true, :validate => Proc.new { |v| v >= 0 }, :desc => "How many old console messages logfiles to keep") - BotConfig.register BotConfigIntegerValue.new('log.max_size', + Config.register Config::IntegerValue.new('log.max_size', :default => 10, :requires_restart => true, :validate => Proc.new { |v| v > 0 }, :desc => "Maximum console messages logfile size (in megabytes)") - BotConfig.register BotConfigArrayValue.new('plugins.path', + Config.register Config::ArrayValue.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', + Config.register Config::EnumValue.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', + Config.register Config::StringValue.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', + Config.register Config::IntegerValue.new('send.max_lines', :default => 5, :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', + Config.register Config::EnumValue.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', + Config.register Config::StringValue.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', + Config.register Config::BooleanValue.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', + Config.register Config::StringValue.new('send.truncate_text', :default => "#{Reverse}...#{Reverse}", :on_change => Proc.new { |bot, v| bot.set_default_send_options :truncate_text => v.dup @@ -328,9 +367,9 @@ class Bot unless botclass and not botclass.empty? # We want to find a sensible default. - # * On POSIX systems we prefer ~/.rbot for the effective uid of the process - # * On Windows (at least the NT versions) we want to put our stuff in the - # Application Data folder. + # * On POSIX systems we prefer ~/.rbot for the effective uid of the process + # * On Windows (at least the NT versions) we want to put our stuff in the + # Application Data folder. # We don't use any particular O/S detection magic, exploiting the fact that # Etc.getpwuid is nil on Windows if Etc.getpwuid(Process::Sys.geteuid) @@ -367,7 +406,7 @@ class Bot @startup_time = Time.new begin - @config = BotConfig.configmanager + @config = Config.manager @config.bot_associate(self) rescue Exception => e fatal e @@ -434,9 +473,9 @@ class Bot pf << "#{$$}\n" end - @registry = BotRegistry.new self + @registry = Registry.new self - @timer = Timer::Timer.new(1.0) # only need per-second granularity + @timer = Timer.new @save_mutex = Mutex.new if @config['core.save_every'] > 0 @save_timer = @timer.add(@config['core.save_every']) { save } @@ -448,10 +487,10 @@ class Bot @logs = Hash.new @plugins = nil - @lang = Language::Language.new(self, @config['core.language']) + @lang = Language.new(self, @config['core.language']) begin - @auth = Auth::authmanager + @auth = Auth::manager @auth.bot_associate(self) # @auth.load("#{botclass}/botusers.yaml") rescue Exception => e @@ -477,7 +516,7 @@ class Bot 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']) + @socket = Irc::Socket.new(@config['server.list'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'], :ssl => @config['server.ssl']) @client = Client.new @plugins.scan @@ -527,23 +566,15 @@ class Bot # 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 + m.ignored = true 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 + @plugins.irc_delegate('privmsg', m) unless m.ignored? } @client[:notice] = proc { |data| message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message]) @@ -589,8 +620,7 @@ class Bot data[:is_on].each { |ch| irclog "@ #{old} is now known as #{new}", ch } - @plugins.delegate("listen", m) - @plugins.delegate("nick", m) + @plugins.irc_delegate("nick", m) } @client[:quit] = proc {|data| source = data[:source] @@ -599,8 +629,7 @@ class Bot data[:was_on].each { |ch| irclog "@ Quit: #{source}: #{message}", ch } - @plugins.delegate("listen", m) - @plugins.delegate("quit", m) + @plugins.irc_delegate("quit", m) } @client[:mode] = proc {|data| irclog "@ Mode #{data[:modestring]} by #{data[:source]}", data[:channel] @@ -609,35 +638,31 @@ class Bot m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message]) irclogjoin(m) - @plugins.delegate("listen", m) - @plugins.delegate("join", m) - sendq "WHO #{data[:channel]}", data[:channel], 2 + @plugins.irc_delegate("join", m) + sendq("WHO #{data[:channel]}", data[:channel], 2) if m.address? } @client[:part] = proc {|data| m = PartMessage.new(self, server, data[:source], data[:channel], data[:message]) irclogpart(m) - @plugins.delegate("listen", m) - @plugins.delegate("part", m) + @plugins.irc_delegate("part", m) } @client[:kick] = proc {|data| m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message]) irclogkick(m) - @plugins.delegate("listen", m) - @plugins.delegate("kick", m) + @plugins.irc_delegate("kick", m) } @client[:invite] = proc {|data| - if data[:target] == myself - join data[:channel] if @auth.allow?("join", data[:source], data[:source].nick) - end + m = InviteMessage.new(self, server, data[:source], data[:target], data[:channel]) + + @plugins.irc_delegate("invite", m) } @client[:changetopic] = proc {|data| m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic]) irclogtopic(m) - @plugins.delegate("listen", m) - @plugins.delegate("topic", m) + @plugins.irc_delegate("topic", m) } @client[:topic] = proc { |data| irclog "@ Topic is \"#{data[:topic]}\"", data[:channel] @@ -648,8 +673,7 @@ class Bot 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) + @plugins.irc_delegate("topic", m) } @client[:names] = proc { |data| @plugins.delegate "names", data[:channel], data[:users] @@ -770,7 +794,6 @@ class Bot begin quit if $interrupted > 0 connect - @timer.start quit_msg = nil while @socket.connected? @@ -954,34 +977,19 @@ class Bot sendmsg "PRIVMSG", where, message, options end + def ctcp_notice(where, command, message, options={}) + return if where.kind_of?(Channel) and quiet_on?(where) + sendmsg "NOTICE", where, "\001#{command} #{message}\001", options + end + + def ctcp_say(where, command, message, options={}) + return if where.kind_of?(Channel) and quiet_on?(where) + sendmsg "PRIVMSG", where, "\001#{command} #{message}\001", 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 - chan = mchan - else - chan = where - end - if mring - ring = mring - else - case where - when User - ring = 1 - else - ring = 2 - end - 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 - else - irclog "* #{myself}[#{where}] #{message}", where - end + ctcp_say(where, 'ACTION', message, options) end # quick way to say "okay" (or equivalent) to +where+ @@ -1012,15 +1020,19 @@ class Bot sendq "TOPIC #{where} :#{topic}", where, 2 end - def disconnect(message = nil) - message = @lang.get("quit") if (message.nil? || message.empty?) + def disconnect(message=nil) + message = @lang.get("quit") if (!message || message.empty?) if @socket.connected? - debug "Clearing socket" - @socket.clearq - debug "Sending quit message" - @socket.emergency_puts "QUIT :#{message}" - debug "Flushing socket" - @socket.flush + begin + debug "Clearing socket" + @socket.clearq + debug "Sending quit message" + @socket.emergency_puts "QUIT :#{message}" + debug "Flushing socket" + @socket.flush + rescue SocketError => e + error "error while disconnecting socket: #{e.pretty_inspect}" + end debug "Shutting down socket" @socket.shutdown end @@ -1033,9 +1045,9 @@ class Bot end # disconnect from the server and cleanup all plugins and modules - def shutdown(message = nil) + def shutdown(message=nil) @quit_mutex.synchronize do - debug "Shutting down:" + debug "Shutting down: #{message}" ## No we don't restore them ... let everything run through # begin # trap("SIGINT", "DEFAULT") @@ -1045,15 +1057,17 @@ class Bot # debug "failed to restore signals: #{e.inspect}\nProbably running on windows?" # end debug "\tdisconnecting..." - disconnect + disconnect(message) + debug "\tstopping timer..." + @timer.stop debug "\tsaving ..." save debug "\tcleaning up ..." @save_mutex.synchronize do @plugins.cleanup end - debug "\tstopping timers ..." - @timer.stop + # debug "\tstopping timers ..." + # @timer.stop # debug "Closing registries" # @registry.close debug "\t\tcleaning up the db environment ..." @@ -1073,9 +1087,9 @@ class Bot end # totally shutdown and respawn the bot - def restart(message = false) - msg = message ? message : "restarting, back in #{@config['server.reconnect_wait']}..." - shutdown(msg) + def restart(message=nil) + message = "restarting, back in #{@config['server.reconnect_wait']}..." if (!message || message.empty?) + shutdown(message) sleep @config['server.reconnect_wait'] begin # now we re-exec @@ -1101,10 +1115,13 @@ class Bot # call the rescan method for all of the botmodules def rescan + debug "\tstopping timer..." + @timer.stop @save_mutex.synchronize do @lang.rescan @plugins.rescan end + @timer.start end # channel:: channel to join @@ -1203,15 +1220,15 @@ class Bot def irclogprivmsg(m) if(m.action?) if(m.private?) - irclog "* [#{m.source}(#{m.sourceaddress})] #{m.message}", m.source + irclog "* [#{m.source}(#{m.sourceaddress})] #{m.logmessage}", m.source else - irclog "* #{m.source} #{m.message}", m.target + irclog "* #{m.source} #{m.logmessage}", m.target end else if(m.public?) - irclog "<#{m.source}> #{m.message}", m.target + irclog "<#{m.source}> #{m.logmessage}", m.target else - irclog "[#{m.source}(#{m.sourceaddress})] #{m.message}", m.source + irclog "[#{m.source}(#{m.sourceaddress})] #{m.logmessage}", m.source end end end @@ -1248,18 +1265,18 @@ class Bot def irclogpart(m) if(m.address?) debug "left channel #{m.channel}" - irclog "@ Left channel #{m.channel} (#{m.message})", m.channel + irclog "@ Left channel #{m.channel} (#{m.logmessage})", m.channel else - irclog "@ #{m.source} left channel #{m.channel} (#{m.message})", m.channel + irclog "@ #{m.source} left channel #{m.channel} (#{m.logmessage})", 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.source} (#{m.message})", m.channel + irclog "@ You have been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel else - irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.source} (#{m.message})", m.channel + irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel end end