X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fircbot.rb;h=7a021fb58f94bfa012840fcc57b20c648dfe77df;hb=be5d914984e767ce1a718b84d0bad1c88d9f8ea3;hp=f8dbc5013cae68321c4476bc3dfee6ab387ca617;hpb=63803e1e37871e1ff6323056fbbebe0cd13453e9;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/ircbot.rb b/lib/rbot/ircbot.rb index f8dbc501..7a021fb5 100644 --- a/lib/rbot/ircbot.rb +++ b/lib/rbot/ircbot.rb @@ -306,6 +306,9 @@ class Bot 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") + Config.register Config::ArrayValue.new('irc.ignore_channels', + :default => [], + :desc => "Which channels to ignore input in. This is mainly to turn the bot into a logbot that doesn't interact with users in any way (in the specified channels)") Config.register Config::IntegerValue.new('core.save_every', :default => 60, :validate => Proc.new{|v| v >= 0}, @@ -434,36 +437,25 @@ class Bot botclass.gsub!("\\","/") end end - botclass += "/.rbot" + botclass = File.join(botclass, ".rbot") end botclass = File.expand_path(botclass) @botclass = botclass.gsub(/\/$/, "") - if FileTest.directory? botclass - # compare the templates dir with the current botclass, and fill it in with - # any missing file. - # Sadly, FileUtils.cp_r doesn't have an :update option, so we have to do it - # manually - template = File.join Config::datadir, 'templates' - # note that we use the */** pattern because we don't want to match - # keywords.rbot, which gets deleted on load and would therefore be missing always - missing = Dir.chdir(template) { Dir.glob('*/**') } - Dir.chdir(botclass) { Dir.glob('*/**') } - missing.map do |f| - dest = File.join(botclass, f) - FileUtils.mkdir_p File.dirname dest - FileUtils.cp File.join(template, f), dest - end - else - log "no #{botclass} directory found, creating from templates.." - if FileTest.exist? botclass - error "file #{botclass} exists but isn't a directory" - exit 2 - end - FileUtils.cp_r Config::datadir+'/templates', botclass - end + repopulate_botclass_directory - Dir.mkdir("#{botclass}/registry") unless File.exist?("#{botclass}/registry") - Dir.mkdir("#{botclass}/safe_save") unless File.exist?("#{botclass}/safe_save") + registry_dir = File.join(@botclass, 'registry') + Dir.mkdir(registry_dir) unless File.exist?(registry_dir) + unless FileTest.directory? registry_dir + error "registry storage location #{registry_dir} is not a directory" + exit 2 + end + save_dir = File.join(@botclass, 'safe_save') + Dir.mkdir(save_dir) unless File.exist?(save_dir) + unless FileTest.directory? save_dir + error "safe save location #{save_dir} is not a directory" + exit 2 + end # Time at which the last PING was sent @last_ping = nil @@ -487,7 +479,9 @@ class Bot @logfile = @config['log.file'] if @logfile.class!=String || @logfile.empty? - @logfile = "#{botclass}/#{File.basename(botclass).gsub(/^\.+/,'')}.log" + logfname = File.basename(botclass).gsub(/^\.+/,'') + logfname << ".log" + @logfile = File.join(botclass, logfname) debug "Using `#{@logfile}' as debug log" end @@ -546,7 +540,7 @@ class Bot end end - File.open($opts['pidfile'] || "#{@botclass}/rbot.pid", 'w') do |pf| + File.open($opts['pidfile'] || File.join(@botclass, 'rbot.pid'), 'w') do |pf| pf << "#{$$}\n" end @@ -576,7 +570,6 @@ class Bot @auth.everyone.set_default_permission("*", true) @auth.botowner.password= @config['auth.password'] - Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins") @plugins = Plugins::manager @plugins.bot_associate(self) setup_plugins_path() @@ -639,11 +632,18 @@ class Bot # debug "Message target is #{data[:target].inspect}" # debug "Bot is #{myself.inspect}" + @config['irc.ignore_channels'].each { |channel| + if m.target.downcase == channel.downcase + m.ignored = true + break + end + } @config['irc.ignore_users'].each { |mask| if m.source.matches?(server.new_netmask(mask)) m.ignored = true + break end - } + } unless m.ignored @plugins.irc_delegate('privmsg', m) } @@ -766,15 +766,54 @@ class Bot trap_sigs end + def repopulate_botclass_directory + template_dir = File.join Config::datadir, 'templates' + if FileTest.directory? @botclass + # compare the templates dir with the current botclass dir, filling up the + # latter with any missing file. Sadly, FileUtils.cp_r doesn't have an + # :update option, so we have to do it manually. + # Note that we use the */** pattern because we don't want to match + # keywords.rbot, which gets deleted on load and would therefore be missing + # always + missing = Dir.chdir(template_dir) { Dir.glob('*/**') } - Dir.chdir(@botclass) { Dir.glob('*/**') } + missing.map do |f| + dest = File.join(@botclass, f) + FileUtils.mkdir_p(File.dirname dest) + FileUtils.cp File.join(template_dir, f), dest + end + else + log "no #{@botclass} directory found, creating from templates..." + if FileTest.exist? @botclass + error "file #{@botclass} exists but isn't a directory" + exit 2 + end + FileUtils.cp_r template_dir, @botclass + end + end + + # Return a path under the current botclass by joining the mentioned + # components. The components are automatically converted to String + def path(*components) + File.join(@botclass, *(components.map {|c| c.to_s})) + end + def setup_plugins_path + plugdir_default = File.join(Config::datadir, 'plugins') + plugdir_local = File.join(@botclass, 'plugins') + Dir.mkdir(plugdir_local) unless File.exist?(plugdir_local) + @plugins.clear_botmodule_dirs - @plugins.add_botmodule_dir(Config::coredir + "/utils") - @plugins.add_botmodule_dir(Config::coredir) - @plugins.add_botmodule_dir("#{botclass}/plugins") + @plugins.add_core_module_dir(File.join(Config::coredir, 'utils')) + @plugins.add_core_module_dir(Config::coredir) + if FileTest.directory? plugdir_local + @plugins.add_plugin_dir(plugdir_local) + else + warning "local plugin location #{plugdir_local} is not a directory" + end @config['plugins.path'].each do |_| - path = _.sub(/^\(default\)/, Config::datadir + '/plugins') - @plugins.add_botmodule_dir(path) + path = _.sub(/^\(default\)/, plugdir_default) + @plugins.add_plugin_dir(path) end end @@ -829,7 +868,8 @@ class Bot # things to do when we receive a signal def got_sig(sig, func=:quit) debug "received #{sig}, queueing #{func}" - $interrupted += 1 + # this is not an interruption if we just need to reconnect + $interrupted += 1 unless func == :reconnect self.send(func) unless @quit_mutex.locked? debug "interrupted #{$interrupted} times" if $interrupted >= 3 @@ -845,6 +885,7 @@ class Bot trap("SIGINT") { got_sig("SIGINT") } trap("SIGTERM") { got_sig("SIGTERM") } trap("SIGHUP") { got_sig("SIGHUP", :restart) } + trap("SIGUSR1") { got_sig("SIGUSR1", :reconnect) } rescue ArgumentError => e debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?" rescue Exception => e @@ -857,6 +898,7 @@ class Bot begin quit if $interrupted > 0 @socket.connect + @last_rec = Time.now rescue => e raise e.class, "failed to connect to IRC server at #{@socket.server_uri}: " + e end @@ -872,15 +914,39 @@ class Bot myself.user = @config['irc.user'] end + # disconnect the bot from IRC, if connected, and then connect (again) + def reconnect(message=nil, too_fast=false) + # we will wait only if @last_rec was not nil, i.e. if we were connected or + # got disconnected by a network error + # if someone wants to manually call disconnect() _and_ reconnect(), they + # will have to take care of the waiting themselves + will_wait = !!@last_rec + + if @socket.connected? + disconnect(message) + end + + if will_wait + log "\n\nDisconnected\n\n" + + quit if $interrupted > 0 + + log "\n\nWaiting to reconnect\n\n" + sleep @config['server.reconnect_wait'] + sleep 10*@config['server.reconnect_wait'] if too_fast + end + + connect + end + # begin event handling loop def mainloop while true too_fast = false begin - quit if $interrupted > 0 - connect - quit_msg = nil + reconnect(quit_msg, too_fast) + quit if $interrupted > 0 while @socket.connected? quit if $interrupted > 0 @@ -906,10 +972,11 @@ class Bot rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e error "network exception: #{e.pretty_inspect}" quit_msg = e.to_s - rescue ServerError + rescue ServerError => e # received an ERROR from the server quit_msg = "server ERROR: " + e.message too_fast = e.message.index("reconnect too fast") + retry rescue BDB::Fatal => e fatal "fatal bdb error: #{e.pretty_inspect}" DBTree.stats @@ -925,16 +992,6 @@ class Bot log_session_end exit 2 end - - disconnect(quit_msg) - - log "\n\nDisconnected\n\n" - - quit if $interrupted > 0 - - log "\n\nWaiting to reconnect\n\n" - sleep @config['server.reconnect_wait'] - sleep 10*@config['server.reconnect_wait'] if too_fast end end @@ -945,8 +1002,22 @@ class Bot # 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, original_message, options={}) - opts = @default_send_options.merge(options) + def sendmsg(original_type, original_where, original_message, options={}) + + # filter message with sendmsg filters + ds = DataStream.new original_message.to_s.dup, + :type => original_type, :dest => original_where, + :options => @default_send_options.merge(options) + filters = filter_names(:sendmsg) + filters.each do |fname| + debug "filtering #{ds[:text]} with sendmsg filter #{fname}" + ds.merge! filter(self.global_filter_name(fname, :sendmsg), ds) + end + + opts = ds[:options] + type = ds[:type] + where = ds[:dest] + filtered = ds[:text] # For starters, set up appropriate queue channels and rings mchan = opts[:queue_channel] @@ -967,7 +1038,7 @@ class Bot end end - multi_line = original_message.to_s.gsub(/[\r\n]+/, "\n") + multi_line = filtered.gsub(/[\r\n]+/, "\n") # if target is a channel with nocolor modes, strip colours if where.kind_of?(Channel) and where.mode.any?(*config['server.nocolor_modes'])