]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - lib/rbot/ircbot.rb
ircbot: sendmsg filtering
[user/henk/code/ruby/rbot.git] / lib / rbot / ircbot.rb
index 01dbb12b4e6c1111bde3ad073a54fea7a770615a..f491b212e1d6b8928cc9305cc3eda946ac318284 100644 (file)
@@ -41,6 +41,9 @@ class Exception
   end
 end
 
+class ServerError < RuntimeError
+end
+
 def rawlog(level, message=nil, who_pos=1)
   call_stack = caller
   if call_stack.length > who_pos
@@ -277,14 +280,6 @@ class Bot
     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")
-    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 })
-    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 })
     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)")
@@ -311,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},
@@ -403,6 +401,13 @@ class Bot
         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")
+    Config.register Config::IntegerValue.new('send.penalty_pct',
+      :default => 100,
+      :validate => Proc.new { |v| v >= 0 },
+      :on_change => Proc.new { |bot, v|
+        bot.socket.penalty_pct = v
+      },
+      :desc => "Percentage of IRC penalty to consider when sending messages to prevent being disconnected for excess flood. Set to 0 to disable penalty control.")
 
     @argv = params[:argv]
     @run_dir = params[:run_dir] || Dir.pwd
@@ -448,7 +453,7 @@ class Bot
       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.mkdir_p(File.dirname dest)
         FileUtils.cp File.join(template, f), dest
       end
     else
@@ -589,7 +594,7 @@ class Bot
         debug "server.list is now #{@config['server.list'].inspect}"
     end
 
-    @socket = Irc::Socket.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'], :ssl => @config['server.ssl'], :penalty_pct =>@config['send.penalty_pct'])
     @client = Client.new
 
     @plugins.scan
@@ -599,6 +604,8 @@ class Bot
     # '*' means all channels
     #
     @quiet = Set.new
+    # but we always speak here
+    @not_quiet = Set.new
 
     # the nick we want, if it's different from the irc.nick config value
     # (e.g. as set by a !nick command)
@@ -609,15 +616,6 @@ class Bot
 
       @plugins.delegate("welcome", m)
       @plugins.delegate("connect")
-
-      @config['irc.join_channels'].each { |c|
-        debug "autojoining channel #{c}"
-        if(c =~ /^(\S+)\s+(\S+)$/i)
-          join $1, $2
-        else
-          join c if(c)
-        end
-      }
     }
 
     # TODO the next two @client should go into rfc2812.rb, probably
@@ -644,11 +642,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)
     }
@@ -707,6 +712,12 @@ class Bot
       m.modes = data[:modes]
       @plugins.delegate "modechange", m
     }
+    @client[:whois] = proc {|data|
+      source = data[:source]
+      target = server.get_user(data[:whois][:nick])
+      m = WhoisMessage.new(self, server, source, target, data[:whois])
+      @plugins.delegate "whois", m
+    }
     @client[:join] = proc {|data|
       m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
       sendq("MODE #{data[:channel]}", nil, 0) if m.address?
@@ -745,6 +756,9 @@ class Bot
       m.users = data[:users]
       @plugins.delegate "names", m
     }
+    @client[:error] = proc { |data|
+      raise ServerError, data[:message]
+    }
     @client[:unknown] = proc { |data|
       #debug "UNKNOWN: #{data[:serverstring]}"
       m = UnknownMessage.new(self, server, server, nil, data[:serverstring])
@@ -795,31 +809,38 @@ class Bot
 
   # checks if we should be quiet on a channel
   def quiet_on?(channel)
-    return @quiet.include?('*') || @quiet.include?(channel.downcase)
+    ch = channel.downcase
+    return (@quiet.include?('*') && !@not_quiet.include?(ch)) || @quiet.include?(ch)
   end
 
   def set_quiet(channel = nil)
     if channel
       ch = channel.downcase.dup
+      @not_quiet.delete(ch)
       @quiet << ch
     else
       @quiet.clear
+      @not_quiet.clear
       @quiet << '*'
     end
   end
 
   def reset_quiet(channel = nil)
     if channel
-      @quiet.delete channel.downcase
+      ch = channel.downcase.dup
+      @quiet.delete(ch)
+      @not_quiet << ch
     else
       @quiet.clear
+      @not_quiet.clear
     end
   end
 
   # 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
@@ -835,6 +856,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
@@ -847,6 +869,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
@@ -862,14 +885,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
 
@@ -895,6 +943,11 @@ class Bot
       rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
         error "network exception: #{e.pretty_inspect}"
         quit_msg = e.to_s
+      rescue ServerError
+        # 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
@@ -910,15 +963,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']
     end
   end
 
@@ -929,8 +973,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]
@@ -951,7 +1009,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'])
@@ -1218,6 +1276,11 @@ class Bot
     sendq "MODE #{channel} #{mode} #{target}", channel, 2
   end
 
+  # asking whois
+  def whois(nick, target=nil)
+    sendq "WHOIS #{target} #{nick}", nil, 0
+  end
+
   # kicking a user
   def kick(channel, user, msg)
     sendq "KICK #{channel} #{user} :#{msg}", channel, 2
@@ -1295,6 +1358,7 @@ class Bot
         m = PrivMessage.new(*args)
       when "QUIT"
         m = QuitMessage.new(*args)
+        m.was_on = myself.channels
     end
     @plugins.delegate('sent', m)
   end