postfix_daemon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 223491e9a76a10604afa95773510d3a217345f67d33839d4a2accef7c8202d67
+  data.tar.gz: 5ae079ffdb492bc9fb52c80e793cafcb1ceedb956237b1418b05dcfde93c967a
+SHA512:
+  metadata.gz: 3cd7e3a6715ecb3f6efec02901c1835453b7763c4e9df0c5522eb0e04a1d3a37a6bd45aff22ae051278fe684b3c6000a12d981b77a141d2ed47f5aaca4434ee0
+  data.tar.gz: 5e6076d6dd6cc709ba2417569a581c6e7b95f83c269c8daa1bbeb0259c20db4e9ede45ff68d3e038f2b8e0267bdf661b0bfefb48b148802455ce3d5a6fe2f87d

data/README.md

@@ -0,0 +1,69 @@
+# PostfixDaemon
+
+Postfixのデーモンプログラムを作るためのライブラリです。
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'postfix_daemon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install postfix_daemon
+
+## Usage
+
+プログラムを書きます。
+
+入力を大文字に変換して返すプログラムの例:
+
+```ruby
+#!/path/to/ruby
+
+require 'postfix_daemon'
+
+# エラー終了してもどこにも出力されないのでリダイレクトしといた方がよさそう
+$stderr.reopen("/tmp/error.log", "a+")
+
+PostfixDaemon.start do |socket, addr|
+  socket.puts "you are #{addr.inspect}"
+  while s = socket.gets
+    s = s.force_encoding("utf-8").scrub
+    socket.puts s.upcase
+  end
+end
+```
+
+プログラムを /usr/lib/postfix/sbin に置きます。
+
+```
+# cp hoge.rb /usr/lib/postfix/sbin/hoge
+# chmod +x /usr/lib/postfix/sbin/hoge
+```
+
+master.cf に追加:
+
+```
+12345   inet   -   -   -   -   -   hoge
+```
+
+postfix reload
+
+```
+# postfix reload
+```
+
+```
+% nc localhost 12345
+you are #<Addrinfo: 127.0.0.1:59312 TCP>
+abcdefg
+ABCDEFG
+^C
+```

data/lib/postfix_daemon.rb

@@ -0,0 +1,137 @@
+require "postfix_daemon/version"
+
+require 'optparse'
+require 'socket'
+require 'syslog'
+
+# Postfix daemon program
+class PostfixDaemon
+  DEFAULT_MAX_IDLE = 100
+  DEFAULT_MAX_USE = 100
+
+  MASTER_STATUS_FD = 5
+  MASTER_LISTEN_FD = 6
+
+  # @param args [Array<String>] command line arguments
+  # @yield [socket, addr]
+  # @yieldparam socket [Socket]
+  # @yieldparam addr [Addrinfo]
+  def self.start(args=ARGV, &block)
+    self.new(args).run(&block)
+  end
+
+  # @param args [Array<String>] command line arguments
+  # @param setup [Proc] called on starting
+  # @param service [Proc] called when client connect
+  def initialize(args, setup: nil, service: nil)
+    @args = args.dup
+    @setup = setup
+    @service = service
+    @nsocks = nil
+    @max_idle = nil
+    @max_use = nil
+  end
+
+  # @yield [socket, addr]
+  # @yieldparam socket [Socket]
+  # @yieldparam addr [Addrinfo]
+  def run(&block)
+    parse_args
+    setup
+    @setup.call if @setup
+    @service = block if block
+    raise 'block required' unless @service
+    main
+  end
+
+  private
+
+  # general Postfix server options:
+  #   -c              master.cf chroot is y, so this process should chroot to queue_directory.
+  #   -d              not daemon mode
+  #   -D              debug mode
+  #   -i #            set max_idle=#
+  #   -l              master.cf maxproc is 1
+  #   -m #            set max_use=#
+  #   -n name         master.cf service name
+  #   -o param=value  param=value
+  #   -s #            number of server sockets
+  #   -S              stdin stream mode
+  #   -t type         master.cf service type (inet, unix, pass)
+  #   -u              master.cf unpriv is y, so this process should setuid to mail_owner.
+  #   -v              verbose mode
+  #   -V              message to stderr
+  #   -z              master.cf maxproc is 0
+  #
+  # This library support only '-s', '-i', '-m' option.
+  def parse_args
+    @args.extend OptionParser::Arguable
+    opts = @args.getopts('cdDi:lm:n:o:s:St:uvVz')
+    @nsocks = opts['s'] ? opts['s'].to_i : 1
+    @max_idle = opts['i'] ? opts['i'].to_i : DEFAULT_MAX_IDLE
+    @max_use = opts['m'] ? opts['m'].to_i : DEFAULT_MAX_USE
+    $VERBOSE = true if opts['v']
+  end
+
+  def setup
+    Syslog.open(File.basename($0), nil, Syslog::LOG_MAIL) unless Syslog.opened?
+    @socks = []
+    fd = MASTER_LISTEN_FD
+    @nsocks.times do
+      @socks.push Socket.for_fd(fd)
+      fd += 1
+    end
+    @stat_fd = IO.for_fd(MASTER_STATUS_FD)
+    @generation = ENV['GENERATION'].to_i(8)
+  end
+
+  def log(message)
+    Syslog.log(Syslog::LOG_INFO, message) if $VERBOSE
+  end
+
+  def main
+    used_count = 0
+    while used_count < @max_use
+      sock, addr = accept
+      break unless sock
+      to_master(0) or break
+      used_count += 1
+      begin
+        @service.call(sock, addr)
+      ensure
+        sock.close rescue nil
+        to_master(1) or break
+      end
+    end
+  rescue => e
+    log "#{e.class}: #{e.message}"
+    raise e
+  end
+
+  # @return [Socket, Addrinfo]
+  def accept
+    while true
+      rs, = select(@socks + [@stat_fd], nil, nil, @max_idle)
+      unless rs
+        log 'idle timeout'
+        return nil
+      end
+      if rs.include? @stat_fd
+        log 'master disconnect'
+        return nil
+      end
+      sock, addr = rs.first.accept_nonblock(exception: false)
+      return sock, addr unless sock == :wait_readable
+    end
+  end
+
+  # @param x [Integer]
+  # @return [Boolean]
+  def to_master(x)
+    @stat_fd.syswrite [Process.pid, @generation, x].pack('iIi')
+    return true
+  rescue Errno::EPIPE
+    log 'master disconnect'
+    return false
+  end
+end

data/lib/postfix_daemon/version.rb

@@ -0,0 +1,3 @@
+class PostfixDaemon
+  VERSION = "0.1.0"
+end

data/sample/postfix_daemon-sample.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require 'postfix_daemon'
+
+PostfixDaemon.start do |socket|
+  while s = socket.gets
+    socket.puts s.upcase
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: postfix_daemon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TOMITA Masahiro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Postfix daemon
+email:
+- tommy@tmtm.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/postfix_daemon.rb
+- lib/postfix_daemon/version.rb
+- sample/postfix_daemon-sample.rb
+homepage: https://github.com/tmtm/postfix_daemon
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Postfix daemon
+test_files: []