fluent-plugin-irc 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af5ed88db24d18583875f6882b7b9d4ef794a944
-  data.tar.gz: 0384195c283d6d18d4a62534b3ea9909134351f5
+  metadata.gz: eb8767007a2ccb458b008a2cb617c77cd2bdfdf4
+  data.tar.gz: d83c2a017287da67e5fe134a8f5dd2c9e7ba6db7
 SHA512:
-  metadata.gz: ec009deb6f1f6b60c253a200803442a109d0f59f8b415528471e984676681250c4d529b70ff91f868211347f24181e5de7c1a463a46331eec8c454160919fac6
-  data.tar.gz: 4150d2d06239c7aa689c438d78b89f3e0f0430d3e77f8e25d9b9a50c43dba0649386adb1c038094493bd079e3ab4871cc0f26a48de783e48a981d12bfb54f1a1
+  metadata.gz: 8fe24e8d588c9d7a2eb13fc4c17beafd1c1b9159dd96121aad1d7bf295d3429509299f340711e327ca298db975c77351a3441e0ddd6ec9f38a9c3151f35d9449
+  data.tar.gz: 7cf9bf5284d5398e92ea9b2a30a881e4ac523732bdcd0568fa153dbe38bb38c685ee9cb14c332ef2b7a6a4205045719e7c8c076eef6ef2e9ddabb75e78b83b7e

data/README.md

@@ -36,6 +36,7 @@ Fluent plugin to send messages to IRC server
 |host|IRC server host|localhost|
 |port|IRC server port number|6667|
 |channel|channel to send messages (without first '#')||
+|channel_keys|keys used to format channel. %s will be replaced with value specified by channel_keys if this option is used|nil|
 |nick|nickname registerd of IRC|fluentd|
 |user|user name registerd of IRC|fluentd|
 |real|real name registerd of IRC|fluentd|
@@ -44,8 +45,10 @@ Fluent plugin to send messages to IRC server
 |time_key|key name for time|time|
 |time_format|time format. This will be formatted with Time#strftime.|%Y/%m/%d %H:%M:%S|
 |tag_key|key name for tag|tag|
-|command|irc command. `priv_msg` or `notice`|priv_msg|
-|channel_keys|keys used to format channel. %s will be replaced with value specified by channel_keys if this option is used|nil|
+|command|irc command. `privmsg` or `notice`|privmsg|
+|command_keys|keys used to format command. %s will be replaced with value specified by command_keys if this option is used|nil|
+|send_interval|interval (sec) to send message. defence Excess Flood|2|
+|send_queue_limit|maximum size of send message queue|100|
 
 ## Copyright
 

data/fluent-plugin-irc.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "fluent-plugin-irc"
-  s.version     = "0.0.6"
+  s.version     = "0.0.7"
   s.authors     = ["OKUNO Akihiro"]
   s.email       = ["choplin.choplin@gmail.com"]
   s.homepage    = "https://github.com/choplin/fluent-plugin-irc"

data/lib/fluent/plugin/out_irc.rb

@@ -25,17 +25,28 @@ module Fluent
     config_param :time_key    , :string  , :default => 'time'
     config_param :time_format , :string  , :default => '%Y/%m/%d %H:%M:%S'
     config_param :tag_key     , :string  , :default => 'tag'
-    config_param :command     , :string  , :default => 'priv_msg'
+    config_param :command     , :string  , :default => 'privmsg'
+    config_param :command_keys, :default => nil do |val|
+      val.split(',')
+    end
 
-    config_param :blocking_timeout, :time, :default => 0.5
+    config_param :blocking_timeout, :time,    :default => 0.5
+    config_param :send_queue_limit, :integer, :default => 100
+    config_param :send_interval,    :time,    :default => 2
 
-    COMMAND_LIST = %w[priv_msg notice]
+    COMMAND_MAP = {
+      'priv_msg' => :priv_msg,
+      'privmsg'  => :priv_msg,
+      'notice'   => :notice,
+    }
 
     # To support log_level option implemented by Fluentd v0.10.43
     unless method_defined?(:log)
       define_method("log") { $log }
     end
 
+    attr_reader :conn # for test
+
     def initialize
       super
       require 'irc_parser'
@@ -59,10 +70,19 @@ module Fluent
       end
       @channel = '#'+@channel
 
-      unless COMMAND_LIST.include?(@command)
-        raise Fluent::ConfigError, "command must be one of #{COMMAND_LIST.join(', ')}"
+      if @command_keys
+        begin
+          @command % (['1'] * @command_keys.length)
+        rescue ArgumentError
+          raise Fluent::ConfigError, "string specifier '%s' and command_keys specification mismatch"
+        end
+      else
+        unless @command = COMMAND_MAP[@command]
+          raise Fluent::ConfigError, "command must be one of #{COMMAND_MAP.keys.join(', ')}"
+        end
       end
 
+      @send_queue = []
     end
 
     def start
@@ -71,6 +91,8 @@ module Fluent
       begin
         @loop = Coolio::Loop.new
         @conn = create_connection
+        @timer = TimerWatcher.new(@send_interval, true, log, &method(:on_timer))
+        @loop.attach(@timer)
         @thread = Thread.new(&method(:run))
       rescue => e
         puts e
@@ -102,17 +124,34 @@ module Fluent
       end
 
       es.each do |time,record|
+        if @send_queue.size >= @send_queue_limit
+          log.warn "out_irc: send queue size exceeded send_queue_limit(#{@send_queue_limit}), discards"
+          break
+        end
+
         filter_record(tag, time, record)
-        @conn.send_message(build_message(record), build_channel(record))
+
+        command = build_command(record)
+        channel = build_channel(record)
+        message = build_message(record)
+
+        log.debug { "out_irc: push {command:\"#{command}\", channel:\"#{channel}\", message:\"#{message}\"}" }
+        @send_queue.push([command, channel, message])
       end
     end
 
+    def on_timer
+      return if @send_queue.empty?
+      command, channel, message = @send_queue.shift
+      log.info { "out_irc: send {command:\"#{command}\", channel:\"#{channel}\", message:\"#{message}\"}" }
+      @conn.send_message(command, channel, message)
+    end
+
     private
 
     def create_connection
       conn = IRCConnection.connect(@host, @port)
-      conn.command = @command
-      conn.channel = '#'+@channel
+      conn.log  = log
       conn.nick = @nick
       conn.user = @user
       conn.real = @real
@@ -122,35 +161,56 @@ module Fluent
     end
 
     def build_message(record)
-      values = @out_keys.map do |key|
-        begin
-          record.fetch(key).to_s
-        rescue KeyError
-          log.warn "out_irc: the specified key '#{key}' not found in record. [#{record}]"
-          ''
-        end
-      end
-
+      values = fetch_keys(record, @out_keys)
       @message % values
     end
 
     def build_channel(record)
       return @channel unless @channel_keys
 
-      values = @channel_keys.map do |key|
+      values = fetch_keys(record, @channel_keys)
+      @channel % values
+    end
+
+    def build_command(record)
+      return @command unless @command_keys
+
+      values = fetch_keys(record, @command_keys)
+      unless command = COMMAND_MAP[@command % values]
+        log.warn "out_irc: command is not one of #{COMMAND_MAP.keys.join(', ')}, use privmsg"
+      end
+      command || :priv_msg
+    end
+
+    def fetch_keys(record, keys)
+      Array(keys).map do |key|
         begin
           record.fetch(key).to_s
         rescue KeyError
-          $log.warn "out_irc: the specified key '#{key}' not found in record. [#{record}]"
+          log.warn "out_irc: the specified key '#{key}' not found in record. [#{record}]"
           ''
         end
       end
+    end
+
+    class TimerWatcher < Coolio::TimerWatcher
+      def initialize(interval, repeat, log, &callback)
+        @callback = callback
+        @log = log
+        super(interval, repeat)
+      end
 
-      @channel % values
+      def on_timer
+        @callback.call
+      rescue
+        @log.error $!.to_s
+        @log.error_backtrace
+      end
     end
 
     class IRCConnection < Cool.io::TCPSocket
-      attr_accessor :command, :channel, :nick, :user, :real, :password
+      attr_reader :joined # for test
+      attr_accessor :log, :nick, :user, :real, :password
 
       def initialize(*args)
         super
@@ -179,13 +239,23 @@ module Fluent
         data.each_line do |line|
           begin
             msg = IRCParser.parse(line)
+            log.debug { "out_irc: on_read :#{msg.class.to_sym}" }
             case msg.class.to_sym
+            when :rpl_welcome
+              log.info { "out_irc: welcome \"#{msg.nick}\" to \"#{msg.prefix}\"" }
             when :ping
               IRCParser.message(:pong) do |m|
                 m.target = msg.target
                 m.body = msg.body
                 write m
               end
+            when :join
+              log.info { "out_irc: joined to #{msg.channels.join(', ')}" }
+              msg.channels.each {|channel| @joined[channel] = true }
+            when :err_nick_name_in_use
+              log.warn "out_irc: nickname \"#{msg.error_nick}\" is already in use. use \"#{@nick}_\" instead."
+              @nick = "#{@nick}_"
+              on_connect
             when :error
               log.warn "out_irc: an error occured. \"#{msg.error_message}\""
             end
@@ -204,16 +274,17 @@ module Fluent
           m.channels = channel
           write m
         end
-        @joined[channel] = true
+        log.debug { "out_irc: join to #{channel}" }
       end
 
-      def send_message(msg, channel)
+      def send_message(command, channel, message)
         join(channel) unless joined?(channel)
-        IRCParser.message(@command) do |m|
+        IRCParser.message(command) do |m|
           m.target = channel
-          m.body = msg
+          m.body = message
           write m
         end
+        channel # return channel for test
       end
     end
   end

data/test/plugin/test_out_irc.rb

@@ -20,9 +20,11 @@ class IRCOutputTest < Test::Unit::TestCase
   def config(
     port: PORT,
     channel: CHANNEL,
-    channel_keys: ""
+    channel_keys: "",
+    command: COMMAND.to_s,
+    command_keys: nil
   )
-    %[
+    config = %[
       type irc
       host localhost
       port #{port}
@@ -31,13 +33,17 @@ class IRCOutputTest < Test::Unit::TestCase
       nick #{NICK}
       user #{USER}
       real #{REAL}
-      command #{COMMAND.to_s}
+      command #{command}
       message #{MESSAGE}
       out_keys tag,time,msg
       time_key time
       time_format #{TIME_FORMAT}
       tag_key tag
+      send_queue_limit 10
+      send_interval 0.5
     ]
+    config += %[command_keys #{command_keys}] if command_keys
+    config
   end
 
 
@@ -54,12 +60,14 @@ class IRCOutputTest < Test::Unit::TestCase
     assert_equal NICK, d.instance.nick
     assert_equal USER, d.instance.user
     assert_equal REAL, d.instance.real
-    assert_equal COMMAND.to_s, d.instance.command
+    assert_equal COMMAND, d.instance.command
     assert_equal MESSAGE, d.instance.message
     assert_equal ["tag","time","msg"], d.instance.out_keys
     assert_equal "time", d.instance.time_key
     assert_equal TIME_FORMAT, d.instance.time_format
     assert_equal "tag", d.instance.tag_key
+    assert_equal 10,  d.instance.send_queue_limit
+    assert_equal 0.5, d.instance.send_interval
   end
 
   def test_configure_channel_keys
@@ -68,6 +76,22 @@ class IRCOutputTest < Test::Unit::TestCase
     assert_equal ["channel"], d.instance.channel_keys
   end
 
+  def test_configure_command_keys
+    d = create_driver(config(command:"%s", command_keys:"command"))
+    assert_equal "%s", d.instance.command
+    assert_equal ["command"], d.instance.command_keys
+  end
+
+  def test_configure_command
+    assert_raise Fluent::ConfigError do
+      create_driver(config(command: 'foo'))
+    end
+
+    assert_nothing_raised { create_driver(config(command: 'priv_msg')) }
+    assert_nothing_raised { create_driver(config(command: 'privmsg')) }
+    assert_nothing_raised { create_driver(config(command: 'notice')) }
+  end
+
   def test_emit
     msg = "test"
     msgs = [{"msg" => msg}]
@@ -75,22 +99,22 @@ class IRCOutputTest < Test::Unit::TestCase
 
     emit_test(msgs) do |socket|
       m = IRCParser.parse(socket.gets)
-      assert_equal m.class.to_sym, :nick
-      assert_equal m.nick, NICK
+      assert_equal :nick, m.class.to_sym
+      assert_equal NICK, m.nick
 
       m = IRCParser.parse(socket.gets)
-      assert_equal m.class.to_sym, :user
-      assert_equal m.user, USER
-      assert_equal m.postfix, REAL
+      assert_equal :user, m.class.to_sym
+      assert_equal USER, m.user
+      assert_equal REAL, m.postfix
 
       m = IRCParser.parse(socket.gets)
-      assert_equal m.class.to_sym, :join
-      assert_equal m.channels, ["##{CHANNEL}"]
+      assert_equal :join, m.class.to_sym, :join
+      assert_equal ["##{CHANNEL}"], m.channels
 
       m = IRCParser.parse(socket.gets)
-      assert_equal m.class.to_sym, COMMAND
-      assert_equal m.target, "##{CHANNEL}"
-      assert_equal m.body, body
+      assert_equal COMMAND, m.class.to_sym
+      assert_equal "##{CHANNEL}", m.target
+      assert_equal body, m.body
 
       assert_nil socket.gets # expects EOF
     end
@@ -113,29 +137,91 @@ class IRCOutputTest < Test::Unit::TestCase
       socket.gets # ignore USER
 
       m = IRCParser.parse(socket.gets)
-      assert_equal m.class.to_sym, :join
-      assert_equal m.channels, ["#chan1"]
+      assert_equal :join, m.class.to_sym
+      assert_equal ["#chan1"], m.channels
 
       m = IRCParser.parse(socket.gets)
-      assert_equal m.class.to_sym, COMMAND
-      assert_equal m.target, "#chan1"
+      assert_equal COMMAND, m.class.to_sym
+      assert_equal "#chan1", m.target
 
       m = IRCParser.parse(socket.gets)
-      assert_equal m.class.to_sym, :join
-      assert_equal m.channels, ["#chan2"]
+      assert_equal :join, m.class.to_sym
+      assert_equal ["#chan2"], m.channels
 
       m = IRCParser.parse(socket.gets)
-      assert_equal m.class.to_sym, COMMAND
-      assert_equal m.target, "#chan2"
+      assert_equal COMMAND, m.class.to_sym
+      assert_equal "#chan2", m.target
 
       m = IRCParser.parse(socket.gets)
-      assert_equal m.class.to_sym, COMMAND
-      assert_equal m.target, "#chan1"
+      assert_equal COMMAND, m.class.to_sym
+      assert_equal "#chan1", m.target
 
       assert_nil socket.gets # expects EOF
     end
   end
 
+  def test_dynamic_command
+    msgs = [
+      {"msg" => "test", "command" => "privmsg"},
+      {"msg" => "test", "command" => "priv_msg"},
+      {"msg" => "test", "command" => "notice"},
+      {"msg" => "test", "command" => "something_wrong"},
+    ]
+
+    extra_config = {
+      command: "%s",
+      command_keys: "command",
+    }
+
+    emit_test(msgs, extra_config: extra_config) do |socket|
+      socket.gets # ignore NICK
+      socket.gets # ignore USER
+
+      m = IRCParser.parse(socket.gets)
+      assert_equal :join, m.class.to_sym
+
+      m = IRCParser.parse(socket.gets)
+      assert_equal :priv_msg, m.class.to_sym
+
+      m = IRCParser.parse(socket.gets)
+      assert_equal :priv_msg, m.class.to_sym
+
+      m = IRCParser.parse(socket.gets)
+      assert_equal :notice, m.class.to_sym
+
+      m = IRCParser.parse(socket.gets)
+      assert_equal :priv_msg, m.class.to_sym # replaced by default priv_msg
+
+      assert_nil socket.gets # expects EOF
+    end
+  end
+
+  def test_fallback_err_nick_name_in_use
+    msgs = [
+      {"msg" => "test", "command" => "privmsg"},
+    ]
+
+    emit_test(msgs) do |socket, d|
+      socket.gets # ignore NICK
+      socket.gets # ignore USER
+      socket.gets # ignore join
+      socket.gets # ignore priv_msg
+
+      # imitate to receive :err_nick_name_in_use
+      conn = d.instance.instance_variable_get(:@conn)
+      IRCParser.message(:err_nick_name_in_use) do |m|
+        conn.on_read(m.to_s)
+      end
+
+      sleep 1
+
+      # test to use `#{NICK}_` instead
+      m = IRCParser.parse(socket.gets)
+      assert_equal :nick, m.class.to_sym
+      assert_equal "#{NICK}_", m.nick
+    end
+  end
+
   private
 
   def emit_test(msgs, extra_config: {}, &block)
@@ -145,13 +231,15 @@ class IRCOutputTest < Test::Unit::TestCase
 
       thread = Thread.new do
         s = serv.accept
-        block.call(s)
+        block.call(s, d)
         s.close
       end
 
       d.run do
         msgs.each do |m|
           d.emit(m, Fluent::Engine.now)
+          channel = d.instance.on_timer
+          d.instance.conn.joined[channel] = true # pseudo join
         end
         # How to remove sleep?
         # It is necessary to ensure that no data remains in Cool.io write buffer before detach.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-irc
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - OKUNO Akihiro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2015-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd