pmux-logview 0.2.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 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,113 @@
+# Pmux::Logview
+
+pmux log viwer
+
+## Requirements
+
+  * ruby
+  * pmux
+  * gflocator
+  * sinatra
+  * json
+
+## Installation
+
+### Install dependency programs
+
+    gem install gflocator
+    gem install pmux
+    gem install sinatra
+    gem install json
+
+### Install pmux-logview
+
+    $ gem install pmux-logview
+
+## Usage
+
+    pmux-logview [options]
+    -c, --config [config_file_path]
+    -F, --foreground
+
+
+## configuration
+
+### Stand alone
+  * pmux-logview configuration (default path = /etc/pmux-logview/pmux-logview.conf)
+     * yaml format file
+
+```lang
+    ---
+    host: 0.0.0.0
+    port: 80
+    default_user: "pmux"
+    use_basic_auth: true
+    password_file_path: "/etc/pmux-logview/password"
+    cache_dir_path: "/var/tmp/pmux-logview"
+    log_dir_path: "/var/log/pmux-logview"
+    log_level: "info"
+    use_syslog: false
+    syslog_facility: "user"
+```
+
+  * basic auth configuration (default path = /etc/pmux-logview/password)
+     * yaml format file
+
+```lang
+    ---
+    user1:
+        pass: pass1
+    user2:
+        pass: pass2
+```
+
+### Rack appliction
+  * config.ru
+
+```lang
+    require 'pmux-logview'
+    configure do
+      # something
+    end
+    Pmux::LogView::Controller.setup({ "default_user" => "pmux",
+                                      "use_basic_auth" =>  true,
+                                      "password_file_path" =>  "/etc/pmux-logview/password",
+                                      "cache_dir_path" => "/var/tmp/pmux-logview",
+                                      "log_dir_path" => "/var/log/pmux-logview",
+                                      "log_level" => "info",
+                                      "use_syslog" => true,
+                                      "syslog_facility" => "user" })
+    run Pmux::LogView::Controller
+```
+
+## Package createting
+
+  * create gem
+
+```lang
+    $ make
+```
+
+  * install
+
+```lang
+    # make install
+    or
+    # gem install pkg/pmux-logview-*.gem
+```
+
+  * create rpm
+
+```lang
+    $ make rpmbuild
+```
+
+  * install rpm
+
+```lang
+    $ rpm -ivh rpm/RPMS/noarch/rubygems-pmux-logview-*.noarch.rpm
+```
+
+## Behaiver
+    - search log file in home directory of pmux user
+    - save cache file in cache directory path

data/Rakefile

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

data/bin/pmux-logview

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

data/conf/config.ru

@@ -0,0 +1,15 @@
+require 'pmux-logview'
+
+configure do
+  # something
+end
+
+Pmux::LogView::Controller.setup({ "default_user" => "pmux",
+                                  "use_basic_auth" =>  true,
+                                  "password_file_path" =>  "/etc/pmux-logview/password",
+                                  "cache_dir_path" => "/var/tmp/pmux-logview",
+                                  "log_dir_path" => "/var/log/pmux-logview",
+                                  "log_level" => "info",
+                                  "use_syslog" => true,
+                                  "syslog_facility" => "user" })
+run Pmux::LogView::Controller

data/conf/password

@@ -0,0 +1,5 @@
+---
+pmux-user1:
+    pass: pass1
+pmux-user2:
+    pass: pass2

data/conf/pmux-logview.conf

@@ -0,0 +1,12 @@
+---
+host: 0.0.0.0
+port: 28080
+pidfile: /var/run/pmux-logview.pid
+default_user: pmux
+use_basic_auth: true
+password_file_path: /etc/pmux-logview/password
+cache_dir_path: /var/tmp/pmux-logview
+log_dir_path: /var/log/pmux-logview
+log_level: info
+use_syslog: true 
+syslog_facility: user

data/lib/pmux-logview.rb

@@ -0,0 +1,11 @@
+File.umask 0022
+ENV['LC_ALL'] = 'C'
+Encoding.default_external = 'ascii-8bit' if RUBY_VERSION > '1.9'
+
+require "pmux-logview/logger_wrapper"
+require "pmux-logview/application"
+require "pmux-logview/auth_helper"
+require "pmux-logview/log_parser"
+require "pmux-logview/model"
+require "pmux-logview/controller"
+require "pmux-logview/version"

data/lib/pmux-logview/application.rb

@@ -0,0 +1,69 @@
+require 'yaml'
+require 'optparse'
+require 'fileutils'
+require 'sinatra'
+
+module Pmux
+  module LogView
+    class Application
+      def initialize
+        @config = nil
+        @foreground = false
+        @config_file_path = "/etc/pmux-logview/pmux-logview.conf"
+        @pidfile = "/var/run/pmux-logview.pid"
+        @host = "0.0.0.0"
+        @port = 28080
+      end
+
+      def parse_args
+        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 load_config
+        @config = {} if @config.nil?
+        return false if @config_file_path.nil? || @config_file_path == ""
+        begin
+          new_config = YAML.load_file(@config_file_path)
+        rescue Errno::ENOENT
+          puts "not found password file (#{@config_file_path})"
+        rescue Errno::EACCES
+          puts "can not access password file (#{@config_file_path})"
+        rescue Exception => e
+          puts "error occurred in password loading: #{e}"
+          puts e.backtrace.join("\n")
+        end
+          @config = new_config
+      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 run
+        initialize()
+        parse_args()
+        daemonize()
+        load_config()
+        @config["foreground"] = @foreground
+        @pidfile = @config["pidfile"] if @config["pidfile"]
+        open(@pidfile, 'w') {|f| f << Process.pid } if @pidfile
+        @host = @config["host"] if @config["host"]
+        @port = @config["port"] if @config["port"]
+        Controller.setup(@config)
+        Controller.run! :host =>@host , :port => @port
+      end
+    end
+  end
+end
+

data/lib/pmux-logview/auth_helper.rb

@@ -0,0 +1,60 @@
+require 'sinatra'
+require 'sinatra/base'
+require 'pmux-logview/logger_wrapper'
+
+module Pmux
+  module LogView
+    module AuthHelper
+      def self.init password_file_path
+        @logger = LoggerWrapper.instance()
+        self.load_config(password_file_path) if @auth_db.nil?
+      end
+
+      def self.update password_file_path
+        self.load_config(password_file_path)
+      end
+
+      def self.load_config password_file_path
+        @auth_db = {} if @auth_db.nil?
+        begin
+          stat = File.stat(password_file_path)
+          mode = "%o" % stat.mode
+          if mode[-3, 3] != "600"
+            @logger.warn("password file permission is not 600 (#{password_file_path})")
+          end
+          new_auth_db = YAML.load_file(password_file_path)
+        rescue Errno::ENOENT
+          @logger.warn("not found password file (#{password_file_path})")
+        rescue Errno::EACCES
+          @logger.warn("can not access password file (#{password_file_path})")
+        rescue Exception => e
+          @logger.warn("error occurred in password loading: #{e}")
+          @logger.warn(e.backtrace.join("\n"))
+        end
+          @auth_db = new_auth_db
+      end
+
+      def self.authenticated request, auth
+        auth ||=  Rack::Auth::Basic::Request.new(request.env)
+        if auth.provided? && auth.basic? && auth.credentials
+          user, pass = auth.credentials
+          if @auth_db && @auth_db[user] && @auth_db[user]["pass"] && @auth_db[user]["pass"] == pass
+            return user
+          end
+        end
+        return nil
+      end
+
+      def self.check_auth! request, response, auth, password_file_path
+        user = self.authenticated(request, auth)
+        if user.nil?
+          response['WWW-Authenticate'] = %(Basic realm="Restricted Area")
+          throw(:halt, [401, "Unauthorized"])
+        end
+        return user
+      end
+    end
+
+    helpers AuthHelper
+  end
+end

data/lib/pmux-logview/controller.rb

@@ -0,0 +1,141 @@
+require 'sinatra'
+require 'sinatra/base'
+require 'json'
+require 'erb'
+require 'fileutils'
+require 'logger'
+
+module Pmux
+  module LogView
+    class Controller < Sinatra::Base
+      @@initialized = false
+      @@foreground = false
+      @@cache_dir_path = "/var/tmp/pmux-logview"
+      @@password_file_path = "/etc/pmux-logview/password"
+      @@log_dir_path = "/var/log/pmux-logview"
+      @@log_filename = "./pmux-logview.log"
+      @@log_level = "info"
+      @@syslog_facility = "daemon"
+      @@use_syslog = false
+      @@use_basic_auth = true
+      @@default_user = "pmux"
+      @@model = nil
+      @@logger = nil
+      @user = nil
+      set :public_folder, File.dirname(__FILE__) + '/static'
+      set :views, File.dirname(__FILE__) + "/views"
+      enable :logging
+      helpers AuthHelper
+
+      def Controller.setup(args)
+        args.each_key{|key|
+          case key
+          when "foreground"
+              @@foreground  = args[key]
+          when "cache_dir_path"
+              @@cache_dir_path = args[key]
+          when "use_basic_auth"
+              @@use_basic_auth = args[key]
+          when "password_file_path"
+              @@password_file_path = args[key]
+          when "log_dir_path"
+              @@log_dir_path = args[key]
+          when "log_level"
+              @@log_level = args[key]
+          when "use_syslog"
+              @@use_syslog = args[key]
+          when "syslog_facility"
+              @@syslog_facility = args[key]
+          when "default_user"
+              @@default_user = args[key]
+          end
+        }
+        log_file_path = File.expand_path([@@log_dir_path, @@log_filename].join(File::SEPARATOR))
+        @@logger.foreground(@@foreground)
+        @@logger.open(log_file_path, @@log_level, @@use_syslog, @@syslog_facility)
+        AuthHelper.update(@@password_file_path)
+        @@model = Model.new(@@cache_dir_path)
+      end
+
+      configure do
+        log_file_path = File.expand_path([@@log_dir_path, @@log_filename].join(File::SEPARATOR))
+        @@logger = LoggerWrapper.instance()
+        @@logger.init()
+        @@logger.open(log_file_path, @@log_level, @@use_syslog, @@syslog_facility)
+        use Rack::CommonLogger, @@logger
+        AuthHelper.init(@@password_file_path)
+        @@model = Model.new(@@cache_dir_path)
+      end
+
+      def logger
+          return env['user.logger'] || env['rack.logger']
+      end
+
+      get '/' do
+        @user = @@default_user if @user.nil?
+        @user = AuthHelper.check_auth!(request, response, @auth, @@password_file_path) if @@use_basic_auth
+        @@logger.info("access user #{@user}")
+        erb :index
+      end
+
+      get '/detail' do
+        @user = @@default_user if @user.nil?
+        @user = AuthHelper.check_auth!(request, response, @auth, @@password_file_path) if @@use_basic_auth
+        @@logger.info("access user #{@user}")
+        @job_id = params[:job_id]
+        erb :detail
+      end
+
+      get '/log/job' do
+        @user = @@default_user if @user.nil?
+        @user = AuthHelper.check_auth!(request, response, @auth, @@password_file_path) if @@use_basic_auth
+        @@logger.info("access user #{@user}")
+        data = {}
+        validations = {
+            "sort_key" => { "default" => "start_time", "type" => String, "values" => [ "job_id", "mapper", "start_time", "end_time", "elapsed_time"] },
+            "sort_order" => { "default" => "desc", "type" => String, "values" => [ "asc", "desc" ] },
+            "type" => { "default" => "archive", "type" => String, "values" => [ "archive", "update" ] },
+            "nitems" => { "default" => 20, "type" => Integer, "values" => nil  },
+            "page" => { "default" => 0, "type" => Integer, "values" => nil },
+            "jobs_cookie" => { "default" => 0, "type" => Integer, "values" => nil },
+        }
+        validations.each_key{|key|
+          if params.key?(key)
+            if (validations[key]["type"] == Integer)
+              data[key] = params[key].to_i
+            else
+              data[key] = params[key]
+            end
+            if (validations[key]["type"] == Integer)
+              data[key] = validations[key]["default"] if data[key] <= 0
+            else 
+              data[key] = validations[key]["default"] if !data[key].kind_of?(validations[key]["type"])
+            end
+            data[key] = validations[key]["default"] if !validations[key]["values"].nil? && !validations[key]["values"].include?(data[key])
+          else
+            data[key] = validations[key]["default"]
+          end
+        }
+	content_type :json
+	return JSON.generate(@@model.get_log_job(@user, data))
+      end
+
+      get '/log/job/:job_id/detail' do
+        @user = @@default_user if @user.nil?
+        @user = AuthHelper.check_auth!(request, response, @auth, @@password_file_path) if @@use_basic_auth
+        @@logger.info("access user #{@user}")
+	content_type :json
+	JSON.generate(@@model.get_log_job_detail(@user, params[:job_id]))
+      end
+
+      get '/log/dispatcher' do
+        @user = @@default_user if @user.nil?
+        @user = AuthHelper.check_auth!(request, response, @auth, @@password_file_path) if @@use_basic_auth
+        @@logger.info("access user #{@user}")
+        content_type :json
+	JSON.generate(@@model.get_log_dispatcher(@user))
+      end
+    end
+  end
+end
+