]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - lib/rbot/ircbot.rb
ircbot.rb: server no-color modes can be configured
[user/henk/code/ruby/rbot.git] / lib / rbot / ircbot.rb
index 01b9d5b636018a06c429ecd458ab120951e7d343..f56813386abfa307a9c4a52ca438d4a54e0b0f5f 100644 (file)
@@ -66,12 +66,20 @@ def rawlog(level, message=nil, who_pos=1)
   $log_queue.push qmsg
 end
 
-def restart_logger
+def halt_logger
   if $log_thread && $log_thread.alive?
     $log_queue << nil
     $log_thread.join
     $log_thread = nil
   end
+end
+
+END { halt_logger }
+
+def restart_logger(newlogger = false)
+  halt_logger
+
+  $logger = newlogger if newlogger
 
   $log_thread = Thread.new do
     ls = nil
@@ -264,6 +272,10 @@ class Bot
     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)")
+    Config.register Config::ArrayValue.new('server.nocolor_modes',
+      :default => ['c'], :wizard => false,
+      :requires_restart => false,
+      :desc => "List of channel modes that require messages to be without colors")
 
     Config.register Config::StringValue.new('irc.nick', :default => "rbot",
       :desc => "IRC nickname the bot should attempt to use", :wizard => true,
@@ -409,7 +421,21 @@ class Bot
     botclass = File.expand_path(botclass)
     @botclass = botclass.gsub(/\/$/, "")
 
-    unless FileTest.directory? botclass
+    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"
@@ -444,6 +470,7 @@ class Bot
     @logfile = @config['log.file']
     if @logfile.class!=String || @logfile.empty?
       @logfile = "#{botclass}/#{File.basename(botclass).gsub(/^\.+/,'')}.log"
+      debug "Using `#{@logfile}' as debug log"
     end
 
     # See http://blog.humlab.umu.se/samuel/archives/000107.html
@@ -462,18 +489,36 @@ class Bot
       end
       Dir.chdir botclass
       # File.umask 0000                # Ensure sensible umask. Adjust as needed.
+    end
+
+    logger = Logger.new(@logfile,
+                        @config['log.keep'],
+                        @config['log.max_size']*1024*1024)
+    logger.datetime_format= $dateformat
+    logger.level = @config['log.level']
+    logger.level = $cl_loglevel if defined? $cl_loglevel
+    logger.level = 0 if $debug
+
+    restart_logger(logger)
+
+    log_session_start
+
+    if $daemonize
       log "Redirecting standard input/output/error"
-      begin
-        STDIN.reopen "/dev/null"
-      rescue Errno::ENOENT
-        # On Windows, there's not such thing as /dev/null
-        STDIN.reopen "NUL"
+      [$stdin, $stdout, $stderr].each do |fd|
+        begin
+          fd.reopen "/dev/null"
+        rescue Errno::ENOENT
+          # On Windows, there's not such thing as /dev/null
+          fd.reopen "NUL"
+        end
       end
-      def STDOUT.write(str=nil)
+
+      def $stdout.write(str=nil)
         log str, 2
         return str.to_s.size
       end
-      def STDERR.write(str=nil)
+      def $stdout.write(str=nil)
         if str.to_s.match(/:\d+: warning:/)
           warning str, 2
         else
@@ -483,15 +528,6 @@ class Bot
       end
     end
 
-    # Set the new logfile and loglevel. This must be done after the daemonizing
-    $logger = Logger.new(@logfile, @config['log.keep'], @config['log.max_size']*1024*1024)
-    $logger.datetime_format= $dateformat
-    $logger.level = @config['log.level']
-    $logger.level = $cl_loglevel if defined? $cl_loglevel
-    $logger.level = 0 if $debug
-
-    log_session_start
-
     File.open($opts['pidfile'] || "#{@botclass}/rbot.pid", 'w') do |pf|
       pf << "#{$$}\n"
     end
@@ -546,7 +582,7 @@ class Bot
     # Array of channels names where the bot should be quiet
     # '*' means all channels
     #
-    @quiet = []
+    @quiet = Set.new
 
     @client[:welcome] = proc {|data|
       m = WelcomeMessage.new(self, server, data[:source], data[:target], data[:message])
@@ -583,7 +619,7 @@ class Bot
     }
 
     @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], :handle_id => true)
       # debug "Message source is #{data[:source].inspect}"
       # debug "Message target is #{data[:target].inspect}"
       # debug "Bot is #{myself.inspect}"
@@ -597,7 +633,7 @@ class Bot
       @plugins.irc_delegate('privmsg', m)
     }
     @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], :handle_id => true)
       # pass it off to plugins that want to hear everything
       @plugins.irc_delegate "notice", message
     }
@@ -653,6 +689,7 @@ class Bot
     }
     @client[:join] = proc {|data|
       m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
+      sendq("MODE #{data[:channel]}", nil, 0) if m.address?
       @plugins.irc_delegate("join", m)
       sendq("WHO #{data[:channel]}", data[:channel], 2) if m.address?
     }
@@ -701,6 +738,8 @@ class Bot
       :split_at => Regexp.new(@config['send.split_at']),
       :purge_split => @config['send.purge_split'],
       :truncate_text => @config['send.truncate_text'].dup
+
+    trap_sigs
   end
 
   def setup_plugins_path
@@ -739,17 +778,17 @@ class Bot
     return @quiet.include?('*') || @quiet.include?(channel.downcase)
   end
 
-  def set_quiet(channel)
+  def set_quiet(channel = nil)
     if channel
       ch = channel.downcase.dup
-      @quiet << ch unless @quiet.include?(ch)
+      @quiet << ch
     else
       @quiet.clear
       @quiet << '*'
     end
   end
 
-  def reset_quiet(channel)
+  def reset_quiet(channel = nil)
     if channel
       @quiet.delete channel.downcase
     else
@@ -758,10 +797,10 @@ class Bot
   end
 
   # things to do when we receive a signal
-  def got_sig(sig)
-    debug "received #{sig}, queueing quit"
+  def got_sig(sig, func=:quit)
+    debug "received #{sig}, queueing #{func}"
     $interrupted += 1
-    quit unless @quit_mutex.locked?
+    self.send(func) unless @quit_mutex.locked?
     debug "interrupted #{$interrupted} times"
     if $interrupted >= 3
       debug "drastic!"
@@ -770,17 +809,21 @@ class Bot
     end
   end
 
-  # connect the bot to IRC
-  def connect
+  # trap signals
+  def trap_sigs
     begin
       trap("SIGINT") { got_sig("SIGINT") }
       trap("SIGTERM") { got_sig("SIGTERM") }
-      trap("SIGHUP") { got_sig("SIGHUP") }
+      trap("SIGHUP") { got_sig("SIGHUP", :restart) }
     rescue ArgumentError => e
       debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?"
     rescue Exception => e
       debug "failed to trap signals: #{e.pretty_inspect}"
     end
+  end
+
+  # connect the bot to IRC
+  def connect
     begin
       quit if $interrupted > 0
       @socket.connect
@@ -889,6 +932,12 @@ class Bot
     end
 
     multi_line = original_message.to_s.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'])
+      multi_line.replace BasicUserMessage.strip_formatting(multi_line)
+    end
+
     messages = Array.new
     case opts[:newlines]
     when :join
@@ -1009,8 +1058,14 @@ class Bot
   end
 
   # set topic of channel +where+ to +topic+
-  def topic(where, topic)
-    sendq "TOPIC #{where} :#{topic}", where, 2
+  # can also be used to retrieve the topic of channel +where+
+  # by omitting the last argument
+  def topic(where, topic=nil)
+    if topic.nil?
+      sendq "TOPIC #{where}", where, 2
+    else
+      sendq "TOPIC #{where} :#{topic}", where, 2
+    end
   end
 
   def disconnect(message=nil)
@@ -1139,7 +1194,7 @@ class Bot
   end
 
   # changing mode
-  def mode(channel, mode, target)
+  def mode(channel, mode, target=nil)
     sendq "MODE #{channel} #{mode} #{target}", channel, 2
   end