X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fircbot.rb;h=f4c1f5bcabb3e7d25e30f3014d079106d6fc5548;hb=a7b1061f7546d9e3be894aa52a90c9a2f0fbae3c;hp=bc6cf76093b08b29369e5d09d431a61519618ea8;hpb=7b7f1309e8c3dbc3bb4408d56489ae5fba77d57a;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git

diff --git a/lib/rbot/ircbot.rb b/lib/rbot/ircbot.rb
index bc6cf760..f4c1f5bc 100644
--- a/lib/rbot/ircbot.rb
+++ b/lib/rbot/ircbot.rb
@@ -13,6 +13,23 @@ $logger.datetime_format = $dateformat
 $logger.level = $cl_loglevel if $cl_loglevel
 $logger.level = 0 if $debug
 
+require 'pp'
+
+unless Kernel.instance_methods.include?("pretty_inspect")
+  def pretty_inspect
+    PP.pp(self, '')
+  end
+  public :pretty_inspect
+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
+    }
+  end
+end
+
 def rawlog(level, message=nil, who_pos=1)
   call_stack = caller
   if call_stack.length > who_pos
@@ -23,7 +40,14 @@ def rawlog(level, message=nil, who_pos=1)
   # Output each line. To distinguish between separate messages and multi-line
   # messages originating at the same time, we blank #{who} after the first message
   # is output.
-  message.to_s.each_line { |l|
+  # Also, we output strings as-is but for other objects we use pretty_inspect
+  case message
+  when String
+    str = message
+  else
+    str = message.pretty_inspect
+  end
+  str.each_line { |l|
     $logger.add(level, l.chomp, who)
     who.gsub!(/./," ")
   }
@@ -89,6 +113,7 @@ module Irc
 # Main bot class, which manages the various components, receives messages,
 # handles them or passes them to plugins, and contains core functionality.
 class Bot
+  COPYRIGHT_NOTICE = "(c) Tom Gilbert and the rbot development team"
   # the bot's Auth data
   attr_reader :auth
 
@@ -123,7 +148,7 @@ class Bot
 
   # 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
@@ -146,14 +171,10 @@ class Bot
   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 +204,12 @@ class Bot
     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 +262,12 @@ class Bot
       :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 +281,7 @@ class Bot
       },
       :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
@@ -280,6 +313,7 @@ class Bot
       :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]
+    @run_dir = params[:run_dir] || Dir.pwd
 
     unless FileTest.directory? Config::coredir
       error "core directory '#{Config::coredir}' not found, did you setup.rb?"
@@ -334,9 +368,8 @@ class Bot
     begin
       @config = BotConfig.configmanager
       @config.bot_associate(self)
-    rescue => e
-      fatal e.inspect
-      fatal e.backtrace.join("\n")
+    rescue Exception => e
+      fatal e
       log_session_end
       exit 2
     end
@@ -359,8 +392,10 @@ class Bot
         exit if fork
       rescue NotImplementedError
         warning "Could not background, fork not supported"
-      rescue => e
-        warning "Could not background. #{e.inspect}"
+      rescue SystemExit
+        exit 0
+      rescue Exception => e
+        warning "Could not background. #{e.pretty_inspect}"
       end
       Dir.chdir botclass
       # File.umask 0000                # Ensure sensible umask. Adjust as needed.
@@ -394,6 +429,10 @@ class Bot
 
     log_session_start
 
+    File.open($opts['pidfile'] || "#{@botclass}/rbot.pid", 'w') do |pf|
+      pf << "#{$$}\n"
+    end
+
     @registry = BotRegistry.new self
 
     @timer = Timer::Timer.new(1.0) # only need per-second granularity
@@ -414,9 +453,8 @@ class Bot
       @auth = Auth::authmanager
       @auth.bot_associate(self)
       # @auth.load("#{botclass}/botusers.yaml")
-    rescue => e
-      fatal e.inspect
-      fatal e.backtrace.join("\n")
+    rescue Exception => e
+      fatal e
       log_session_end
       exit 2
     end
@@ -424,21 +462,25 @@ class Bot
     @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.name'], @config['server.port'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'], :ssl => @config['server.ssl'])
+    @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
     # Array of channels names where the bot should be quiet
     # '*' means all channels
@@ -517,7 +559,7 @@ class Bot
       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.
+      # to inform us that our nick has been changed.
       if data[:target] == '*'
         debug "setting my connection nick to #{new}"
         nick = new
@@ -534,6 +576,8 @@ class Bot
       @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]
@@ -622,6 +666,18 @@ class Bot
       :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,19 +740,23 @@ class Bot
       trap("SIGTERM") { got_sig("SIGTERM") }
       trap("SIGHUP") { got_sig("SIGHUP") }
     rescue ArgumentError => e
-      debug "failed to trap signals (#{e.inspect}): running on Windows?"
-    rescue => e
-      debug "failed to trap signals: #{e.inspect}"
+      debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?"
+    rescue Exception => e
+      debug "failed to trap signals: #{e.pretty_inspect}"
     end
     begin
       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 and the rbot development team"
+    @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']
@@ -710,6 +770,7 @@ class Bot
         connect
         @timer.start
 
+        quit_msg = nil
         while @socket.connected?
           quit if $interrupted > 0
 
@@ -733,38 +794,31 @@ class Bot
         log_session_end
         exit 0
       rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
-        error "network exception: #{e.class}: #{e}"
-        debug e.backtrace.join("\n")
+        error "network exception: #{e.pretty_inspect}"
+        quit_msg = e.to_s
       rescue BDB::Fatal => e
-        fatal "fatal bdb error: #{e.class}: #{e}"
-        fatal e.backtrace.join("\n")
+        fatal "fatal bdb error: #{e.pretty_inspect}"
         DBTree.stats
         # Why restart? DB problems are serious stuff ...
         # restart("Oops, we seem to have registry problems ...")
         log_session_end
         exit 2
       rescue Exception => e
-        error "non-net exception: #{e.class}: #{e}"
-        error e.backtrace.join("\n")
+        error "non-net exception: #{e.pretty_inspect}"
+        quit_msg = e.to_s
       rescue => e
-        fatal "unexpected exception: #{e.class}: #{e}"
-        fatal e.backtrace.join("\n")
+        fatal "unexpected exception: #{e.pretty_inspect}"
         log_session_end
         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
@@ -798,16 +852,16 @@ class Bot
       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}"
@@ -836,56 +890,47 @@ class Bot
     # 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
 
@@ -947,12 +992,16 @@ class Bot
   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
 
@@ -961,10 +1010,30 @@ class Bot
     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
-      debug "Shutting down ..."
+      debug "Shutting down:"
       ## No we don't restore them ... let everything run through
       # begin
       #   trap("SIGINT", "DEFAULT")
@@ -973,30 +1042,19 @@ class Bot
       # 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
-      }
-      debug "Saving"
+      debug "\tdisconnecting..."
+      disconnect
+      debug "\tsaving ..."
       save
-      debug "Cleaning up"
+      debug "\tcleaning up ..."
       @save_mutex.synchronize do
         @plugins.cleanup
       end
+      debug "\tstopping timers ..."
+      @timer.stop
       # debug "Closing registries"
       # @registry.close
-      debug "Cleaning up the db environment"
+      debug "\t\tcleaning up the db environment ..."
       DBTree.cleanup_env
       log "rbot quit (#{message})"
     end
@@ -1017,9 +1075,18 @@ class Bot
     msg = message ? message : "restarting, back in #{@config['server.reconnect_wait']}..."
     shutdown(msg)
     sleep @config['server.reconnect_wait']
-    # now we re-exec
-    # Note, this fails on Windows
-    exec($0, *@argv)
+    begin
+      # now we re-exec
+      # Note, this fails on Windows
+      debug "going to exec #{$0} #{@argv.inspect} from #{@run_dir}"
+      Dir.chdir(@run_dir)
+      exec($0, *@argv)
+    rescue Errno::ENOENT
+      exec("ruby", *(@argv.unshift $0))
+    rescue Exception => e
+      $interrupted += 1
+      raise e
+    end
   end
 
   # call the save method for all of the botmodules
@@ -1130,15 +1197,15 @@ class Bot
   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
@@ -1168,7 +1235,7 @@ class Bot
       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
 
@@ -1177,16 +1244,16 @@ class Bot
       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