pmux-gw 0.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pmux-gw.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Hiroyuki Kakine
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Makefile

@@ -0,0 +1,18 @@
+RUBY_VERID?=default
+
+default: build
+
+build: clean
+	rake build
+
+install: clean
+	rake install
+
+rpmbuild: clean
+	cd rpm && make clean
+	rake build
+	cd rpm && make RUBY_VERID=$(RUBY_VERID)
+
+clean:
+	cd rpm && make clean
+	rm -rf pkg

data/README.md

@@ -0,0 +1,145 @@
+## Pmux::Gateway
+
+   Pmux gateway is an executor for Pmux (https://github.com/iij/pmux) through HTTP request.
+
+## Requirements
+
+  * ruby 1.8.7, 1.9.3 or higher
+  * pmux 
+  * gflocator 
+  * eventmachine 
+  * em_pessimistic
+  * eventmacnine/evma_httpserver https://github.com/eventmachine/evma_httpserver.git 
+
+## Installation
+
+### Install dependency programs
+  
+  gem install gflocator  
+  gem install pmux  
+  gem install eventmachine  
+  gem install em_pessimistic  
+  git clone https://github.com/eventmachine/evma_httpserver.git  
+  cd evma_httpserver  
+  rake gem:build  
+  gem install eventmachine_httpserver-0.2.1.gem  
+  (I do not recommend "gem install eventmachine_httpserver")  
+  
+### Install pmux-gw
+
+  gem install pmux-gw  
+
+## Usage
+
+  pmux-gw [-c config] [-F] [-h]  
+  -c : specified config file  
+  -F : foreground mode  
+  -h : print usage  
+
+## Quick start
+
+### Install glusterfs client (http://www.gluster.org/)
+
+#### CentOS/RHEL
+
+  rpm -ivh glusterfs-3.3.1-1.el6.x86_64.rpm  
+  rpm -ivh glusterfs-fuse-3.3.1-1.el6.x86_64.rpm  
+
+### Create an environment that can use pmux
+
+  mkdir /mnt/volume  
+  mount -t glusterfs gfsnode1:volume /mnt/volume  
+  gflocator  
+  useradd -m admin  
+  sudo -u admin ssh-keygen  
+  (copy publickey to glusterfs nodes)  
+
+### Make sure that the following command will work  
+
+  sudo -u admin pmux --status -h 127.0.0.1  
+  sudo -u admin pmux --mapper="ls -al" --storage=glusterfs --locator-host=127.0.0.1  /mnt/volume  
+ 
+### Create an environment that can use pmux-gw
+
+  mkdir /etc/pmux-gw  
+  cp <pmux-geteway-install-path>/examples/pmux-gw.conf /etc/pmux-gw/pmux-gw.conf  
+  cp <pmux-geteway-install-path>/examples/password /etc/pmux-gw/password  
+  chown -R admin:admin /etc/pmux-gw/password  
+  chmod -R 600 /etc/pmux-gw/password  
+  pmux-gw  
+  curl --basic -u user:pass -iv  'http://127.0.0.1:18080/pmux?mapper=ls&file=/'  
+
+## Resource URL
+
+### http://<server_name>:18080/pmux
+
+  Resource to execute the Pmux
+
+#### method
+
+  * GET
+  * POST
+
+#### parameters 
+
+  * mapper
+    * Specified as a string to exected mapper command.
+    * Must be placed on the glusterfs mapper program
+    * Be distributed to each glusterfs nodes using ship-file is possible mapper program on glusterfs
+  * file  
+    * Specifies the file to be processed
+    * This parameter can be specified multiple
+    * Can also be used with file-glob
+    * The default program is not distributed reducer
+    * Specifies the path on the volume that was mounted
+  * file-glob
+    * Specified in the expression pattern of the shell files to be processed
+    * Specification of the pattern, according to the specifications of the pattern glob (3)
+    * This parameter can be specified multiple
+    * Can also be used with file-glob
+    * The default program is not distributed reducer
+    * Specifies the path on the volume that was mounted
+  * ship-file
+    * Specifies the path of the file to be distributed to each node of the pmux
+    * You use this if you want to distribute to each node in the mapper program on the glusterfs pmux
+    * Can be distributed more files than mapper script (configuration files, for example)
+    * This parameter can be specified multiple
+    * Specifies the path on the volume that was mounted
+  * reducer
+    * specified as a string to be executed reducer command
+    * Reducer is not used the program default
+  * num-r
+    * Reducer to run the program number.
+    * Default 0 is used
+  * ff
+    * Number of tasks if you want to be lumped fine fusion task
+    * I do not fusion when omitted
+  * storage
+    * Specify the type of storage you want to use
+    * Default is "glusterfs"
+  * locator-host
+    * Specifies the hostname or address of the locator to return the position of the entity in the file
+    * default is "127.0.0.1"
+  * locator-port
+    * Specifies the port number of the locator that returns the position of the entity in the file
+    * Default is automatically set according to the type of storage
+  * detect-error 
+    * Specifies the on / off
+    * if on, Return a response waiting for the completion of the execution of pmux, it checks whether an error occurred. 
+    * The default is off
+
+### http://<server_name>:18080/history
+
+  Resources of the request to refer to the history
+
+### http://<server_name>:18080/existence
+
+  Resources to monitor the presence of process
+     
+## Links
+ * Glusterfs
+   * http://www.gluster.org/
+ * Gflocator
+   * https://github.com/iij/gflocator
+ * Pmux
+   * https://github.com/iij/pmux

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new

data/bin/pmux-gw

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'pmux-gw'
+
+app = Pmux::Gateway::Application.new()
+app.run()

data/examples/password

@@ -0,0 +1,4 @@
+---
+user:
+  volume-prefix: volume
+  password: pass

data/examples/pmux-gw.conf

@@ -0,0 +1,15 @@
+---
+bind_address:  "0.0.0.0"
+bind_port: 18080
+user: "admin"
+group: "admin"
+glusterfs_root: "/mnt"
+max_tasks: 512
+max_content_size: 1048576
+use_basic_auth: true
+password_file_path: "/etc/pmux-w/password"
+history_file_path: "/var/log/pmux-gw/history"
+log_file_path: "/var/log/pmux-w/pmux-gw.log"
+log_level: "info"
+use_syslog: false
+syslog_facility: "local0"

data/lib/pmux-gw/application.rb

@@ -0,0 +1,226 @@
+require 'yaml'
+require 'etc'
+require 'optparse'
+require 'fileutils'
+
+module Pmux
+  module Gateway
+    class Application
+      def initialize
+        @config_file_path = "/etc/pmux-gw/pmux-gw.conf"
+        @foreground = false
+        @reload = false
+        @term = false
+        @logger = nil
+      end
+    
+      def argparse
+        OptionParser.new do |opt|
+          opt.on('-c [config_file_path]', '--config [config_file_path]') {|v| @config_file_path = v}
+          opt.on('-F', '--foreground') {|v| @foreground = true}
+          opt.parse!(ARGV)
+        end
+      end
+    
+      def daemonize
+        if !@foreground
+          exit!(0) if Process.fork
+          Process.setsid
+          exit!(0) if Process.fork
+          STDIN.reopen("/dev/null", "r")
+          STDOUT.reopen("/dev/null", "w")
+          STDERR.reopen("/dev/null", "w")
+        end
+      end
+    
+      def load_config
+        # コンフィグのロード、リロード処理
+        # グローバル変数 $config はここで作る
+        begin
+          $config = YAML.load_file(@config_file_path)
+        rescue Errno::ENOENT
+          if @logger.nil?
+            puts "not found config file (#{@config_file_path})"
+          else
+            @logger.logging("error", "not found config file (#{@config_file_path})")
+          end
+        rescue Errno::EACCES
+          if @logger.nil?
+            puts "can not access config file (#{@config_file_path})"
+          else
+            @logger.logging("error", "can not access config file (#{@config_file_path})")
+          end
+        rescue Exception => e
+          # コンフィグ読み込み中に予期しないエラーが起きた
+          if @logger.nil?
+            puts "error occurred in config loading: #{e}"
+            puts e.backtrace.join("\n") 
+          else
+            @logger.logging("error", "error occurred in config loading: #{e}")
+            @logger.logging("error", e.backtrace.join("\n"))
+          end
+        end
+        # 必要なディレクトリを作る
+        # 作れなければ、ログに残して続行
+        begin
+          histdir = File.dirname($config["history_file_path"])
+          logdir = File.dirname($config["log_file_path"])
+          FileUtils.mkdir_p(histdir) unless File.exist?(histdir)
+          FileUtils.mkdir_p(logdir) unless File.exist?(logdir)
+          FileUtils.chown_R($config["user"], $config["group"], histdir)
+          FileUtils.chown_R($config["user"], $config["group"], logdir)
+        rescue Exception => e
+          if @logger.nil?
+            puts "error occurred in directory creating: #{e}"
+            puts e.backtrace.join("\n")
+          else
+            @logger.logging("error", "error occurred in directory creating: #{e}")
+            @logger.logging("error", e.backtrace.join("\n"))
+          end
+        end
+      end
+    
+      def load_userdb
+        $userdb = {} if $userdb.nil?
+        # パスワードファイルの読み込み
+        # パーミッションをチェックする
+        # グローバル変数 $userdb はここで作る
+        # $userdbがnilなら空のマップにする 
+        # 読み込みに何らかの理由で失敗したらログに残し、前の状態から変更しない
+        if $config["use_basic_auth"]
+          return false if $config["password_file_path"].nil? || $config["password_file_path"] == ""
+          stat = File.stat($config["password_file_path"])
+          mode = "%o" % stat.mode
+          if mode[-3, 3] != "600"
+            if @logger.nil?
+              puts "password file permission is not 600 (#{$config['password_file_path']})"
+            else
+              @logger.logging("error", "password file permission is not 600 (#{$config['password_file_path']})")
+            end
+            return false
+          end
+          begin
+            $userdb = YAML.load_file($config["password_file_path"])
+          rescue Errno::ENOENT
+            if @logger.nil?
+              puts "not found password file (#{$config['password_file_path']})"
+            else
+              @logger.logging("error", "not found password file (#{$config['password_file_path']})")
+            end
+          rescue Errno::EACCES
+            if @logger.nil?
+              puts "can not access password file (#{$config['password_file_path']})"
+            else
+              @logger.logging("error", "can not access password file (#{$config['password_file_path']})")
+            end
+          rescue Exception => e
+            # password読み込み中に予期しないエラーが起きた
+            if @logger.nil?
+              puts "error occurred in password loading: #{e}"
+              puts e.backtrace.join("\n")
+            else
+              @logger.logging("error", "error occurred in password loading: #{e}")
+              @logger.logging("error", e.backtrace.join("\n"))
+            end
+          end
+        end
+        return true
+      end
+    
+      def run
+        argparse()
+        daemonize()
+    
+        # シグナルを受るとフラグを設定するようにする
+        Signal.trap(:INT) { @term = true }
+        Signal.trap(:TERM) { @term = true }
+        Signal.trap(:HUP) { @reload = true }
+    
+        # コンフィグの読み込み
+        load_config()
+    
+        # ユーザーとグループの情報を取得する
+        user = Etc.getpwnam($config["user"])
+        group = Etc.getgrnam($config["group"])
+    
+        # ユーザー情報読み込み
+        exit(1) if !load_userdb()
+
+        # syslogラッパーインスタンス作成
+        @syslog = SyslogWrapper.instance()
+
+        # ロガーラッパーインスタンスの作成と初期化
+        @logger = LoggerWrapper.instance()
+        @logger.init(@foreground)
+    
+        # 履歴処理インスタンスの作成と初期化
+        @history = History.instance()
+        @history.init($config["history_file_path"], @logger)
+    
+        begin
+          EM.run do
+            # httpサーバーを開始する
+            EM.start_server($config["bind_address"], $config["bind_port"], HttpHandler)
+    
+            # ユーザー権限を変更
+            Process::GID.change_privilege(group.gid)
+            Process::UID.change_privilege(user.uid) 
+    
+            # pmuxが読み込む環境変数を上書き
+            ENV["USER"] = $config["user"]
+            ENV["LOGNAME"] = $config["user"]
+            ENV["HOME"] = user.dir
+    
+            # リソースリミットの設定
+            soft, hard = Process.getrlimit(Process::RLIMIT_NPROC)
+            proc_margin = 32
+            if soft - proc_margin < $config["max_tasks"] || hard - proc_margin < $config["max_tasks"]
+              proc_limit = $config["max_tasks"] + proc_margin
+              Process.setrlimit(Process::RLIMIT_NPROC, proc_limit, proc_limit)
+            end
+
+            # syslogのオープン
+            @syslog.open($config["use_syslog"],  $config["syslog_facility"])
+    
+            # ロガーのオープン
+            @logger.open($config["log_file_path"], $config["log_level"])
+    
+            # シグナル受信フラグを処理する定期実行タイマー
+            @periodic_timer = EM::PeriodicTimer.new(1) do
+              # reloadフラグが立っていればリロードする
+              if @reload 
+                @logger.logging("info", "config reloading...")
+                load_config()
+                load_userdb()
+                # syslogとロガーをリオープンと履歴処理インスタンスのリセット
+                @syslog.open($config["use_syslog"], $config["syslog_facility"])
+                @logger.open($config["log_file_path"], $config["log_level"])
+                @history.reset($config["history_file_path"])
+                @reload = false
+              end
+              # 終了フラグが立っていると終了処理
+              if @term 
+                HttpHandler.set_term()
+                if HttpHandler.get_task_cnt() == 0:
+                  @logger.logging("info", "shutdown...")
+                  @periodic_timer.cancel()
+                  @history.finish()
+                  @logger.close()
+                  EM.stop()
+                end
+              end
+              sleep(1)
+            end
+          end
+        rescue Exception => e
+          # event machine内で予期せぬ例外で死んだ場合ログに残す
+          @logger.logging("error", "error occurred in eventmachine: #{e}")
+          @logger.logging("error", e.backtrace.join("\n"))
+          @history.finish()
+          @logger.close()
+          raise e
+        end
+      end
+    end
+  end
+end    

data/lib/pmux-gw/client_context.rb

@@ -0,0 +1,40 @@
+module Pmux
+  module Gateway
+    class ClientContext
+      # 処理に必要なクライアントの情報を保持するクラス
+      def initialize request, response, mapper, command, detect_error
+        @request = request
+        @response = response
+        @mapper = mapper
+        @command = command
+        @detect_error = detect_error
+        @stdout_data = ""
+        @stderr_data = ""
+        @pmux_terminated = false
+        @force_pmux_terminated = false
+        @content_too_big = false
+        @pid = nil
+        @start_datetime = nil
+        @end_datetime = nil
+        @peername = nil
+        @user = nil
+        @status = "init"
+      end 
+    
+      def set_pmux_handler pmux_handler
+        @pmux_handler = pmux_handler
+      end
+    
+      def append_stdout_data data
+        @stdout_data << data
+      end
+    
+      def append_stderr_data data
+        @stderr_data << data
+      end
+    
+      attr_reader :request, :response, :pmux_handler, :mapper, :command, :detect_error, :stdout_data, :stderr_data
+      attr_accessor :pmux_terminated, :force_pmux_terminated, :content_too_big, :pid, :start_datetime, :end_datetime, :status, :peername, :user
+    end
+  end
+end

data/lib/pmux-gw/history.rb

@@ -0,0 +1,149 @@
+require 'singleton'
+require 'date'
+require 'cgi'
+
+module Pmux
+  module Gateway 
+    class History
+      include Singleton
+    
+      @@date_format = "%Y_%m_%d"
+   
+      def init history_file_path, logger
+        @syslog_wrapper = SyslogWrapper.instance()
+        @history_file_path = history_file_path
+        @logger = logger
+        @last_rotate = Date.today()
+        @file_path = build_file_path(@last_rotate)
+        @fp = nil
+        @reset = false
+      end
+    
+      def reset history_file_path
+        @history_file_path = history_file_path
+        @reset = true
+      end
+
+      def finish
+        @fp.close() if !@fp.nil?
+      end
+    
+      def build_file_path d
+        return "#{@history_file_path}-#{d.strftime(@@date_format)}"
+      end
+    
+      def build_id cc
+        # peername, pid, mapper, start_datetimeからユニークなidを作る
+        # 内部的に使うだけなので文字列をつなげただけのもの
+        return "#{cc.peername}#{cc.pid}#{cc.mapper}#{cc.start_datetime.to_s}"
+      end
+    
+      def rotate
+        # 日付が変わっていればローテート処理
+        if @fp.nil?
+          begin
+            @fp = open(@file_path, "a")
+          rescue Errno::ENOENT => e
+            @logger.logging("error", "not found history file (#{@file_path})")
+            @logger.logging("error", "error: #{e}")
+          rescue Errno::EACCES => e
+            @logger.logging("error", "can not access history file (#{@file_path})")
+            @logger.logging("error", "error: #{e}")
+          end
+        end
+        new_last_rotate = Date.today()
+        if new_last_rotate.day != @last_rotate.day || @reset
+          @file_path = build_file_path(@last_rotate)
+          if !@fp.nil?
+            @fp.close()
+            @fp = nil
+          else
+            @logger.logging("error", "can not close file, file object is nil")
+          end
+          begin
+            @fp = open(@file_path, "a") 
+            @last_rotate = new_last_rotate
+            @reset = false
+          rescue Errno::ENOENT => e
+            @logger.logging("error", "not found history file (#{@file_path})")
+            @logger.logging("error", "error: #{e}")
+          rescue Errno::EACCES => e
+            @logger.logging("error", "can not access history file (#{@file_path})")
+            @logger.logging("error", "error: #{e}")
+          end
+        end
+      end
+    
+      def save cc
+        # idを作成する
+        id = build_id(cc)
+        # rotateを行う
+        rotate()
+        # historyに追加書き込み
+        # フォーマット(タブ区切り):
+        #   id\tpeername\tpid\tmapper\tstart_datetime\tend_datetime\tstatus\tcommand\n
+        if !cc.end_datetime.nil?
+          elapsed = ((cc.end_datetime - cc.start_datetime) * 86400).to_f
+        else
+          elapsed = nil
+        end
+        if !@fp.nil?
+          msg = "#{id}\t#{cc.peername}\t#{cc.user}\t#{cc.pid}\t#{cc.mapper}\t#{cc.start_datetime.to_s}\t#{cc.end_datetime.to_s}\t#{elapsed}\t#{cc.status}\t#{cc.command}\n"
+          @fp.write(msg)
+          @fp.flush()
+          @syslog_wrapper.logging("history", "info", msg);
+        else
+          @logger.logging("error", "can not write file, file object is nil")
+        end
+      end
+    
+      def is_skip elems, peername, pid, mapper, start_datetime
+        return true if !peername.nil? && peername != "" &&  /#{peername}/ !~ elems[1]
+        return true if !pid.nil? && pid != "" && /#{pid}/ !~ elems[3]
+        return true if !mapper.nil? && mapper != "" && /#{mapper}/ !~ elems[4]
+        return true if !start_datetime.nil? && start_datetime != "" && start_datetime != elems[5] 
+      end
+    
+      def load peername, pid, mapper, start_datetime, start_date, end_date, need_command = false, html_escape = false
+        # 指定された期間のログファイルからデータを読み込む
+        # フォーマット(タブ区切り):
+        #   id\tpeername\tuser\tpid\tmapper\tstart_datetime\tend_datetime\telapsed\tstatus\tcommand\n
+        # ヒストリの順番はhistory_id_orderに保存し
+        # ヒストリの内容はhistoryに保存する
+        history_id_order = []
+        history = {}
+        while (end_date - start_date).to_i >= 0 do
+          file_path = build_file_path(start_date)
+          begin
+            open(file_path) {|file|
+              while line = file.gets() do
+                elems = line.chomp().split("\t")
+                next if is_skip(elems, peername, pid, mapper, start_datetime)
+                id = elems.shift()
+                command = elems.pop() if !need_command
+                elems.unshift(start_date.to_s)
+                elems.each_with_index { |e, i| elems[i] = CGI.escapeHTML(e) } if html_escape
+                if history.key?(id)
+                  # すでにidが存在しているのでmapだけを更新
+                  history[id] = elems
+                else 
+                  # idが存在していないのでmapを更新してリストにidを追加
+                  history_id_order << id
+                  history[id] = elems
+                end
+              end
+            }
+          rescue Errno::ENOENT => e
+            @logger.logging("info", "not found history file (#{file_path})")
+            @logger.logging("info", "error: #{e}")
+          rescue Errno::EACCES => e
+            @logger.logging("info", "can not access history file (#{file_path})")
+            @logger.logging("info", "error: #{e}")
+          end
+          start_date += 1
+        end
+        return [ history, history_id_order.reverse! ]
+      end
+    end
+ end
+end