Add Windows support

.gitignore

@@ -21,4 +21,5 @@ test/config/tmp/*
 make_dist.sh
 Gemfile.local
 .ruby-version
+*.swp
 coverage/*

appveyor.yml

@@ -0,0 +1,25 @@
+version: '{build}'
+
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - "%devkit%\\devkitvars.bat"
+  - ruby --version
+  - gem --version
+  - bundle install
+build: off
+test_script:
+  - bundle exec rake test TESTOPTS=-v
+
+environment:
+  matrix:
+    - ruby_version: "22-x64"
+      devkit: C:\Ruby21-x64\DevKit
+    - ruby_version: "22"
+      devkit: C:\Ruby21\DevKit
+    - ruby_version: "21-x64"
+      devkit: C:\Ruby21-x64\DevKit
+    - ruby_version: "21"
+      devkit: C:\Ruby21\DevKit
+matrix:
+  allow_failures:
+    - ruby_version: "21"

fluentd.gemspec

@@ -22,19 +22,25 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency("msgpack", [">= 0.5.11", "< 0.6.0"])
   gem.add_runtime_dependency("json", [">= 1.4.3"])
   gem.add_runtime_dependency("yajl-ruby", ["~> 1.0"])
-  gem.add_runtime_dependency("cool.io", [">= 1.2.2", "< 2.0.0"])
+  gem.add_runtime_dependency("cool.io", [">= 1.4.1", "< 2.0.0"])
   gem.add_runtime_dependency("http_parser.rb", [">= 0.5.1", "< 0.7.0"])
   gem.add_runtime_dependency("sigdump", ["~> 0.2.2"])
   gem.add_runtime_dependency("tzinfo", [">= 1.0.0"])
   gem.add_runtime_dependency("tzinfo-data", [">= 1.0.0"])
   gem.add_runtime_dependency("string-scrub", [">= 0.0.3"])
+  if /mswin|mingw/ =~ RUBY_PLATFORM
+    gem.add_runtime_dependency("win32-service", ["~> 0.8.3"])
+    gem.add_runtime_dependency("win32-ipc", ["~> 0.6.1"])
+    gem.add_runtime_dependency("win32-event", ["~> 0.6.1"])
+    gem.add_runtime_dependency("windows-pr", ["~> 1.2.3"])
+  end
 
   gem.add_development_dependency("rake", [">= 0.9.2"])
-  gem.add_development_dependency("flexmock")
+  gem.add_development_dependency("flexmock", ["~> 1.3.3"])
   gem.add_development_dependency("parallel_tests", [">= 0.15.3"])
   gem.add_development_dependency("simplecov", ["~> 0.6.4"])
   gem.add_development_dependency("rr", [">= 1.0.0"])
   gem.add_development_dependency("timecop", [">= 0.3.0"])
-  gem.add_development_dependency("test-unit", ["~> 3.0.2"])
+  gem.add_development_dependency("test-unit", ["~> 3.1.4"])
   gem.add_development_dependency("test-unit-rr", ["~> 1.0.3"])
 end

lib/fluent/command/fluentd.rb

@@ -16,6 +16,13 @@
 
 require 'optparse'
 require 'fluent/supervisor'
+require 'fluent/log'
+require 'fluent/env'
+require 'fluent/version'
+require 'windows/library'
+include Windows::Library
+
+$fluentdargv = Marshal.load(Marshal.dump(ARGV))
 
 op = OptionParser.new
 op.version = Fluent::VERSION
@@ -34,6 +41,10 @@
   opts[:dry_run] = b
 }
 
+op.on('--show-plugin-config=PLUGIN', "Show PLUGIN configuration and exit(ex: input:dummy)") {|plugin|
+  opts[:show_plugin_config] = plugin
+}
+
 op.on('-p', '--plugin DIR', "add plugin directory") {|s|
   opts[:plugin_dirs] << s
 }
@@ -115,6 +126,19 @@
   opts[:gem_install_path] = s
 }
 
+op.on('-x', '--signame INTSIGNAME', "an object name which is used for Windows Service signal (Windows only)") {|s|
+  opts[:signame] = s
+}
+
+op.on('--reg-winsvc MODE', "install/uninstall as Windows Service. (i: install, u: uninstall) (Windows only)") {|s|
+  opts[:regwinsvc] = s
+}
+
+op.on('--reg-winsvc-fluentdopt OPTION', "specify fluentd option paramters for Windows Service. (Windows only)") {|s|
+  opts[:fluentdopt] = s
+}
+
+
 (class<<self;self;end).module_eval do
   define_method(:usage) do |msg|
     puts op.to_s
@@ -164,4 +188,48 @@
   exit 0
 end
 
+if winsvcinstmode = opts[:regwinsvc]
+  FLUENTD_WINSVC_NAME="fluentdwinsvc"
+  FLUENTD_WINSVC_DISPLAYNAME="Fluentd Windows Service"
+  FLUENTD_WINSVC_DESC="Fluentd is an event collector system."
+  require 'fileutils'
+  require "win32/service"
+  require "win32/registry"
+  include Win32
+
+  case winsvcinstmode
+  when 'i'
+    binary_path = File.join(File.dirname(__FILE__), "..")
+    ruby_path = "\0" * 256
+    GetModuleFileName.call(0,ruby_path,256)
+    ruby_path = ruby_path.rstrip.gsub(/\\/, '/')
+
+    Service.create(
+      :service_name => FLUENTD_WINSVC_NAME,
+      :host => nil,
+      :service_type => Service::WIN32_OWN_PROCESS,
+      :description => FLUENTD_WINSVC_DESC,
+      :start_type => Service::DEMAND_START,
+      :error_control => Service::ERROR_NORMAL,
+      :binary_path_name => ruby_path+" -C "+binary_path+" winsvc.rb",
+      :load_order_group => "",
+      :dependencies => [""],
+      :display_name => FLUENTD_WINSVC_DISPLAYNAME
+    )
+  when 'u'
+    Service.delete(FLUENTD_WINSVC_NAME)
+  else
+    # none
+  end
+  exit 0
+end
+
+if fluentdopt = opts[:fluentdopt]
+  Win32::Registry::HKEY_LOCAL_MACHINE.open("SYSTEM\\CurrentControlSet\\Services\\fluentdwinsvc", Win32::Registry::KEY_ALL_ACCESS) do |reg|
+    reg['fluentdopt', Win32::Registry::REG_SZ] = fluentdopt
+  end
+  exit 0
+end
+
+require 'fluent/supervisor'
 Fluent::Supervisor.new(opts).start

lib/fluent/config/configure_proxy.rb

@@ -17,7 +17,7 @@
 module Fluent
   module Config
     class ConfigureProxy
-      attr_accessor :name, :final, :param_name, :required, :multi, :alias, :argument, :params, :defaults, :sections
+      attr_accessor :name, :final, :param_name, :required, :multi, :alias, :argument, :params, :defaults, :descriptions, :sections
       # config_param :desc, :string, :default => '....'
       # config_set_default :buffer_type, :memory
       #
@@ -48,6 +48,7 @@ def initialize(name, opts = {})
         @argument = nil # nil: ignore argument
         @params = {}
         @defaults = {}
+        @descriptions = {}
         @sections = {}
       end
 
@@ -157,6 +158,10 @@ def parameter_configuration(name, *args, &block)
           config_set_default(name, opts[:default])
         end
 
+        if opts.has_key?(:desc)
+          config_set_desc(name, opts[:desc])
+        end
+
         [name, block, opts]
       end
 
@@ -189,6 +194,17 @@ def config_set_default(name, defval)
         nil
       end
 
+      def config_set_desc(name, description)
+        name = name.to_sym
+
+        if @descriptions.has_key?(name)
+          raise ArgumentError, "#{self.name}: description specified twice for #{name}"
+        end
+
+        @descriptions[name] = description
+        nil
+      end
+
       def config_section(name, *args, &block)
         unless block_given?
           raise ArgumentError, "#{self.name}: config_section requires block parameter"
@@ -208,6 +224,20 @@ def config_section(name, *args, &block)
 
         name
       end
+
+      def dump(level = 0)
+        dumped_config = "\n"
+        indent = " " * level
+        @params.each do |name, config|
+          dumped_config << "#{indent}#{name}: #{config[1][:type]}: <#{@defaults[name].inspect}>"
+          dumped_config << " # #{@descriptions[name]}" if @descriptions[name]
+          dumped_config << "\n"
+        end
+        @sections.each do |section_name, sub_proxy|
+          dumped_config << "#{indent}#{section_name}#{sub_proxy.dump(level + 1)}"
+        end
+        dumped_config
+      end
     end
   end
 end

lib/fluent/configurable.rb

@@ -121,6 +121,10 @@ def merged_configure_proxy
         # p AnyGreatClass.dup.name #=> nil
         configurables.map{ |a| a.configure_proxy(a.name || a.object_id.to_s) }.reduce(:merge)
       end
+
+      def dump
+        configure_proxy_map[self.to_s].dump
+      end
     end
   end
 

lib/fluent/load.rb

@@ -15,6 +15,8 @@
   # ignore setup error on Win or similar platform which doesn't support signal
 end
 require 'cool.io'
+
+$platformwin = /mswin|mingw/ === RUBY_PLATFORM
 require 'fluent/env'
 require 'fluent/version'
 require 'fluent/log'

lib/fluent/output.rb

@@ -91,6 +91,8 @@ def secondary_init(primary)
         $log.warn "type of secondary output should be same as primary output", :primary=>primary.class.to_s, :secondary=>self.class.to_s
       end
     end
+
+    def inspect; "#<%s:%014x>" % [self.class.name, '0x%014x' % (__id__<<1)] end
   end
 
 

lib/fluent/plugin/buf_file.rb

@@ -21,6 +21,7 @@ def initialize(key, path, unique_id, mode="a+", symlink_path = nil)
       @path = path
       @unique_id = unique_id
       @file = File.open(@path, mode, DEFAULT_FILE_PERMISSION)
+      @file.binmode
       @file.sync = true
       @size = @file.stat.size
       FileUtils.ln_sf(@path, symlink_path) if symlink_path
@@ -65,8 +66,20 @@ def open(&block)
     end
 
     def mv(path)
-      File.rename(@path, path)
-      @path = path
+      if defined?(Windows)
+        pos = @file.pos
+        @file.close
+        File.rename(@path, path)
+        @path = path
+        @file = File.open(@path, 'rb', DEFAULT_FILE_PERMISSION)
+        @file.sync = true
+        @size = @file.size
+        @file.pos = pos
+        @size = @file.stat.size
+      else
+        File.rename(@path, path)
+        @path = path
+      end
     end
   end