]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - lib/rbot/ircbot.rb
New auth framework is now backwards compatible: auth <masterpassword> works again...
[user/henk/code/ruby/rbot.git] / lib / rbot / ircbot.rb
index 42f39b163fad89c2ab002de850d1c29da24bbd1d..432b61c40d4180653331bb5f5152d7ad098203e3 100644 (file)
@@ -73,9 +73,7 @@ require 'rbot/utils'
 
 require 'rbot/irc'
 require 'rbot/rfc2812'
-require 'rbot/keywords'
 require 'rbot/ircsocket'
-# require 'rbot/auth'
 require 'rbot/botuser'
 require 'rbot/timer'
 require 'rbot/plugins'
@@ -104,17 +102,13 @@ class IrcBot
   # by default)
   attr_reader :timer
 
+  # synchronize with this mutex while touching permanent data files:
+  # saving, flushing, cleaning up ...
+  attr_reader :save_mutex
+
   # bot's Language data
   attr_reader :lang
 
-  # server the bot is connected to
-  # TODO multiserver
-  attr_reader :server
-
-  # the client personality of the bot
-  # TODO multiserver
-  attr_reader :client
-
   # bot's irc socket
   # TODO multiserver
   attr_reader :socket
@@ -131,8 +125,17 @@ class IrcBot
   # proxies etc as defined by the bot configuration/environment
   attr_reader :httputil
 
+  # server we are connected to
+  # TODO multiserver
+  def server
+    @client.server
+  end
+
   # bot User in the client/server connection
-  attr_reader :myself
+  # TODO multiserver
+  def myself
+    @client.client
+  end
 
   # bot User in the client/server connection
   def nick
@@ -268,7 +271,16 @@ class IrcBot
     @pong_timer = nil
     @last_ping = nil
     @startup_time = Time.new
-    @config = BotConfig.new(self)
+
+    begin
+      @config = BotConfig.configmanager
+      @config.bot_associate(self)
+    rescue => e
+      fatal e.inspect
+      fatal e.backtrace.join("\n")
+      log_session_end
+      exit 2
+    end
 
     if @config['core.run_as_daemon']
       $daemonize = true
@@ -326,7 +338,9 @@ class IrcBot
     @registry = BotRegistry.new self
 
     @timer = Timer::Timer.new(1.0) # only need per-second granularity
+    @save_mutex = Mutex.new
     @timer.add(@config['core.save_every']) { save } if @config['core.save_every']
+    @quit_mutex = Mutex.new
 
     @logs = Hash.new
 
@@ -334,8 +348,6 @@ class IrcBot
 
     @lang = Language::Language.new(@config['core.language'])
 
-    # @keywords = Keywords.new(self)
-
     begin
       @auth = Auth::authmanager
       @auth.bot_associate(self)
@@ -346,25 +358,26 @@ class IrcBot
       log_session_end
       exit 2
     end
+    @auth.everyone.set_default_permission("*", true)
+    @auth.botowner.password= @config['auth.password']
 
     Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
     @plugins = Plugins::pluginmanager
     @plugins.bot_associate(self)
-    @plugins.load_core(Config::coredir)
-    @plugins.load_plugins(["#{botclass}/plugins"])
+    @plugins.add_botmodule_dir(Config::coredir)
+    @plugins.add_botmodule_dir("#{botclass}/plugins")
+    @plugins.add_botmodule_dir(Config::datadir + "/plugins")
+    @plugins.scan
 
     @socket = IrcSocket.new(@config['server.name'], @config['server.port'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'])
     @client = IrcClient.new
-    @server = @client.server
-    @myself = @client.client
-    @myself.nick = @config['irc.nick']
+    myself.nick = @config['irc.nick']
 
     # Channels where we are quiet
     # It's nil when we are not quiet, an empty list when we are quiet
     # in all channels, a list of channels otherwise
     @quiet = nil
 
-
     @client[:welcome] = proc {|data|
       irclog "joined server #{@client.server} as #{myself}", "server"
 
@@ -383,18 +396,21 @@ class IrcBot
       # TODO this needs to go into rfc2812.rb
       # Since capabs are two-steps processes, server.supports[:capab]
       # should be a three-state: nil, [], [....]
-      sendq "CAPAB IDENTIFY-MSG" if @server.supports[:capab]
+      sendq "CAPAB IDENTIFY-MSG" if server.supports[:capab]
     }
     @client[:datastr] = proc { |data|
       # TODO this needs to go into rfc2812.rb
       if data[:text] == "IDENTIFY-MSG"
-        @server.capabilities["identify-msg".to_sym] = true
+        server.capabilities["identify-msg".to_sym] = true
       else
         debug "Not handling RPL_DATASTR #{data[:servermessage]}"
       end
     }
     @client[:privmsg] = proc { |data|
-      m = PrivMessage.new(self, @server, data[:source], data[:target], data[:message])
+      m = PrivMessage.new(self, server, data[:source], data[:target], data[:message])
+      # debug "Message source is #{data[:source].inspect}"
+      # debug "Message target is #{data[:target].inspect}"
+      # debug "Bot is #{myself.inspect}"
 
       # TODO use the new Netmask class
       # @config['irc.ignore_users'].each { |mask| return if Irc.netmaskmatch(mask,m.source) }
@@ -402,10 +418,10 @@ class IrcBot
       irclogprivmsg(m)
 
       @plugins.delegate "listen", m
-      @plugins.privmsg(m)
+      @plugins.privmsg(m) if m.address?
     }
     @client[:notice] = proc { |data|
-      message = NoticeMessage.new(self, @server, data[:source], data[:target], data[:message])
+      message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message])
       # pass it off to plugins that want to hear everything
       @plugins.delegate "listen", message
     }
@@ -431,7 +447,7 @@ class IrcBot
       source = data[:source]
       old = data[:oldnick]
       new = data[:newnick]
-      m = NickMessage.new(self, @server, source, old, new)
+      m = NickMessage.new(self, server, source, old, new)
       if source == myself
         debug "my nick is now #{new}"
       end
@@ -444,7 +460,7 @@ class IrcBot
     @client[:quit] = proc {|data|
       source = data[:source]
       message = data[:message]
-      m = QuitMessage.new(self, @server, source, source, message)
+      m = QuitMessage.new(self, server, source, source, message)
       data[:was_on].each { |ch|
         irclog "@ Quit: #{source}: #{message}", ch
       }
@@ -455,21 +471,21 @@ class IrcBot
       irclog "@ Mode #{data[:modestring]} by #{data[:source]}", data[:channel]
     }
     @client[:join] = proc {|data|
-      m = JoinMessage.new(self, @server, data[:source], data[:channel], data[:message])
+      m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
       irclogjoin(m)
 
       @plugins.delegate("listen", m)
       @plugins.delegate("join", m)
     }
     @client[:part] = proc {|data|
-      m = PartMessage.new(self, @server, data[:source], data[:channel], data[:message])
+      m = PartMessage.new(self, server, data[:source], data[:channel], data[:message])
       irclogpart(m)
 
       @plugins.delegate("listen", m)
       @plugins.delegate("part", m)
     }
     @client[:kick] = proc {|data|
-      m = KickMessage.new(self, @server, data[:source], data[:target], data[:channel],data[:message])
+      m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message])
       irclogkick(m)
 
       @plugins.delegate("listen", m)
@@ -481,7 +497,7 @@ class IrcBot
       end
     }
     @client[:changetopic] = proc {|data|
-      m = TopicMessage.new(self, @server, data[:source], data[:channel], data[:topic])
+      m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic])
       irclogtopic(m)
 
       @plugins.delegate("listen", m)
@@ -494,7 +510,7 @@ class IrcBot
       channel = data[:channel]
       topic = channel.topic
       irclog "@ Topic set by #{topic.set_by} on #{topic.set_on}", channel
-      m = TopicMessage.new(self, @server, data[:source], channel, topic)
+      m = TopicMessage.new(self, server, data[:source], channel, topic)
 
       @plugins.delegate("listen", m)
       @plugins.delegate("topic", m)
@@ -535,14 +551,12 @@ class IrcBot
   def got_sig(sig)
     debug "received #{sig}, queueing quit"
     $interrupted += 1
+    quit unless @quit_mutex.locked?
     debug "interrupted #{$interrupted} times"
-    if $interrupted >= 5
+    if $interrupted >= 3
       debug "drastic!"
       log_session_end
       exit 2
-    elsif $interrupted >= 3
-      debug "quitting"
-      quit
     end
   end
 
@@ -563,8 +577,10 @@ class IrcBot
     rescue => e
       raise e.class, "failed to connect to IRC server at #{@config['server.name']} #{@config['server.port']}: " + e
     end
+    quit if $interrupted > 0
     @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"
+    quit if $interrupted > 0
     start_server_pings
   end
 
@@ -577,11 +593,11 @@ class IrcBot
         @timer.start
 
         while @socket.connected?
+         quit if $interrupted > 0
           if @socket.select
             break unless reply = @socket.gets
             @client.process reply
           end
-         quit if $interrupted > 0
         end
 
       # I despair of this. Some of my users get "connection reset by peer"
@@ -590,7 +606,7 @@ class IrcBot
       rescue SystemExit
         log_session_end
         exit 0
-      rescue Errno::ETIMEDOUT, TimeoutError, SocketError => e
+      rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
         error "network exception: #{e.class}: #{e}"
         debug e.backtrace.join("\n")
       rescue BDB::Fatal => e
@@ -612,7 +628,7 @@ class IrcBot
       end
 
       stop_server_pings
-      @server.clear
+      server.clear
       if @socket.connected?
         @socket.clearq
         @socket.shutdown
@@ -735,8 +751,6 @@ class IrcBot
     case where
     when Channel
       irclog "* #{myself} #{message}", where
-    when User
-      irclog "* #{myself}[#{where}] #{message}", $1
     else
       irclog "* #{myself}[#{where}] #{message}", where
     end
@@ -768,39 +782,43 @@ class IrcBot
 
   # disconnect from the server and cleanup all plugins and modules
   def shutdown(message = nil)
-    debug "Shutting down ..."
-    ## No we don't restore them ... let everything run through
-    # begin
-    #   trap("SIGINT", "DEFAULT")
-    #   trap("SIGTERM", "DEFAULT")
-    #   trap("SIGHUP", "DEFAULT")
-    # 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
+    @quit_mutex.synchronize do
+      debug "Shutting down ..."
+      ## No we don't restore them ... let everything run through
+      # begin
+      #   trap("SIGINT", "DEFAULT")
+      #   trap("SIGTERM", "DEFAULT")
+      #   trap("SIGHUP", "DEFAULT")
+      # 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"
+      save
+      debug "Cleaning up"
+      @save_mutex.synchronize do
+        @plugins.cleanup
+      end
+      # debug "Closing registries"
+      # @registry.close
+      debug "Cleaning up the db environment"
+      DBTree.cleanup_env
+      log "rbot quit (#{message})"
     end
-    debug "Logging quits"
-    @server.channels.each { |ch|
-      irclog "@ quit (#{message})", ch
-    }
-    debug "Saving"
-    save
-    debug "Cleaning up"
-    @plugins.cleanup
-    # debug "Closing registries"
-    # @registry.close
-    debug "Cleaning up the db environment"
-    DBTree.cleanup_env
-    log "rbot quit (#{message})"
   end
 
   # message:: optional IRC quit message
@@ -823,20 +841,20 @@ class IrcBot
     exec($0, *@argv)
   end
 
-  # call the save method for bot's config, keywords, auth and all plugins
+  # call the save method for all of the botmodules
   def save
-    @config.save
-    # @keywords.save
-    @auth.save
-    @plugins.save
-    DBTree.cleanup_logs
+    @save_mutex.synchronize do
+      @plugins.save
+      DBTree.cleanup_logs
+    end
   end
 
-  # call the rescan method for the bot's lang, keywords and all plugins
+  # call the rescan method for all of the botmodules
   def rescan
-    @lang.rescan
-    @plugins.rescan
-    # @keywords.rescan
+    @save_mutex.synchronize do
+      @lang.rescan
+      @plugins.rescan
+    end
   end
 
   # channel:: channel to join
@@ -865,35 +883,28 @@ class IrcBot
       sendq "MODE #{channel} #{mode} #{target}", channel, 2
   end
 
-  # # m::     message asking for help
-  # # topic:: optional topic help is requested for
-  # # respond to online help requests
-  # def help(topic=nil)
-  #   topic = nil if topic == ""
-  #   case topic
-  #   when nil
-  #     helpstr = "help topics: core, auth, keywords"
-  #     helpstr += @plugins.helptopics
-  #     helpstr += " (help <topic> for more info)"
-  #   when /^core$/i
-  #     helpstr = corehelp
-  #   when /^core\s+(.+)$/i
-  #     helpstr = corehelp $1
-  #   when /^auth$/i
-  #     helpstr = @auth.help
-  #   when /^auth\s+(.+)$/i
-  #     helpstr = @auth.help $1
-  #   when /^keywords$/i
-  #     helpstr = @keywords.help
-  #   when /^keywords\s+(.+)$/i
-  #     helpstr = @keywords.help $1
-  #   else
-  #     unless(helpstr = @plugins.help(topic))
-  #       helpstr = "no help for topic #{topic}"
-  #     end
-  #   end
-  #   return helpstr
-  # end
+  # kicking a user
+  def kick(channel, user, msg)
+      sendq "KICK #{channel} #{user} :#{msg}", channel, 2
+  end
+
+  # m::     message asking for help
+  # topic:: optional topic help is requested for
+  # respond to online help requests
+  def help(topic=nil)
+    topic = nil if topic == ""
+    case topic
+    when nil
+      helpstr = "help topics: "
+      helpstr += @plugins.helptopics
+      helpstr += " (help <topic> for more info)"
+    else
+      unless(helpstr = @plugins.help(topic))
+        helpstr = "no help for topic #{topic}"
+      end
+    end
+    return helpstr
+  end
 
   # returns a string describing the current status of the bot (uptime etc)
   def status
@@ -968,8 +979,6 @@ class IrcBot
         case where
         when Channel
           irclog "-=#{myself}=- #{message}", where
-        when User
-             irclog "[-=#{where}=-] #{message}", $1
         else
              irclog "[-=#{where}=-] #{message}", where
         end
@@ -977,8 +986,6 @@ class IrcBot
         case where
         when Channel
           irclog "<#{myself}> #{message}", where
-        when User
-          irclog "[msg(#{where})] #{message}", $1
         else
           irclog "[msg(#{where})] #{message}", where
         end
@@ -1003,7 +1010,6 @@ class IrcBot
     end
   end
 
-  # respond to being kicked from a channel
   def irclogkick(m)
     if(m.address?)
       debug "kicked from channel #{m.channel}"