rec 1.1.0 → 1.1.1

data/CHANGELOG

@@ -1,18 +1,19 @@
-Version 1.1.0::
-    - Added mplex.rb to support merging of event streams
-    - Added MULTIPLEX documentation
+=== Version 1.1.1
+- added mplex.rb to support merging of event streams
+- added MULTIPLEX documentation
+- added optional post-install script to install mplex executable
 
-Version 1.0.9::
-    - Removed mock-notify.rb
+=== Version 1.0.9
+- Removed mock-notify.rb
 
-Version 1.0.7::
-	- Simplified rdoc markup for the benefit of yard.
+=== Version 1.0.7
+- Simplified rdoc markup for the benefit of yard.
 
-Version 1.0.6::
-	- Restructured for better compatibility with gem standards
+=== Version 1.0.6
+- Restructured for better compatibility with gem standards
 
-Version 1.0.4::
-	- Added examples
+=== Version 1.0.4
+- Added examples
 
-Version 1.0.1::
-	- Initial version
+=== Version 1.0.1
+- Initial version

data/lib/mplex

@@ -0,0 +1,117 @@
+#!/usr/local/bin/ruby
+require 'getoptlong'
+require 'io/wait'
+
+version = "1.0.0"
+
+usage =<<-EOT
+mplex - an IO multiplexer
+Usage: mplex [OPTION] -i infile [-i infile2...] -o outfile [-o outfile2...]
+  where mplex reads from one or more infiles and writes to one or more outfiles.
+  --input, -i   the path to a log file to read from
+  --output, -o  the path to a log file to write to
+  --help, -h    display usage
+  --version, -v show version
+  --debug, -d   display each line on stdout as it is passes through mplex
+Examples:
+  $ mplex -i input1.log -i input2.log -o output3.log
+    combines two input files into a single output stream
+  $ mplex -i in.log -i in2.log -o out3.log -o out4.log -o out5.log
+    combines two input streams and writes to 3 output streams
+Note:
+Stdin and Stdout do not participate in the multiplexing, so make sure
+to prefix any filename with either -i or -o
+EOT
+
+options = GetoptLong.new(
+  [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
+  [ '--version', '-v', GetoptLong::NO_ARGUMENT ],
+  [ '--debug', '-d', GetoptLong::NO_ARGUMENT ],
+  [ '--input', '-i', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '--output', '-o', GetoptLong::REQUIRED_ARGUMENT ]
+)
+
+infilenames = []
+outfilenames = []
+options.each { |opt, arg|
+  case opt
+  when "--help"
+    puts(usage)
+    exit 0
+  when "--version"
+    puts("mplex version #{version}")
+    exit 0
+  when "--input"
+    infilenames << arg
+  when "--output"
+    outfilenames << arg
+  when "--debug"
+    debug = true
+  end
+}
+
+# No arguments should be provided on the command line
+# If they were, maybe someone forgot to use the -i or -o options
+if ARGV.length > 0
+  puts("Warning: every filename must have -i or -o before it. No other arguments are accepted.")
+  puts(usage)
+  exit 1
+end
+
+# Allow graceful shutdown
+["INT", "TERM", "QUIT"].each { |sig|
+  Signal.trap(sig) {
+    exit(0)
+  }
+}
+
+# Check if the infiles exist and are readable
+failure = false
+infilenames.each { |f|
+  if File.exists?(f)
+    unless File.readable?(f)
+      puts("File #{f} is not readable")
+      failure = true
+    end
+  else
+    puts("File #{f} does not exist")
+    failure = true
+  end
+}
+if failure
+  puts(usage)
+  exit 2
+end
+
+# Open all infiles and outfiles
+infiles = infilenames.collect { |path|
+   File.new(path, File::RDONLY)
+}
+outfiles = outfilenames.collect { |path|
+  File.new(path, File::APPEND|File::CREAT|File::WRONLY)
+}
+
+# Multiplex the IO streams
+loop {
+  reads = 0
+  infiles.each { |i|
+    line = i.gets().chomp() if i.ready?
+    reads = reads.succ unless line.nil?
+    if line
+      outfiles.each { |o|
+        o.puts(line)
+        o.flush()
+      }
+      puts(line) if debug and not line.nil?
+    end
+  }
+  sleep(1) if reads == 0
+}
+
+# Close all files
+infiles.each { |i|
+  i.close unless i.closed?
+}
+outfiles.each { |o|
+  o.close unless o.closed?
+}

data/lib/rec/install.rb

@@ -0,0 +1,51 @@
+require 'fileutils'
+
+#______________________
+if Process.euid != 0
+  puts("This script must be run as root")
+  exit 1
+end
+
+#______________________
+# Enable graceful exit especially while seeking input
+["INT", "TERM", "QUIT"].each { |sig|
+  Signal.trap(sig) {
+    puts("")
+    exit(0)
+  }
+}
+
+#______________________
+# display intent
+bindir = File.expand_path("../../bin", File.dirname(__FILE__))
+
+puts("Installing mplex...")
+
+#______________________
+# confirm path to install to
+sbindir = "/usr/local/sbin"
+confirmed = false
+begin
+  print("Install to path [#{sbindir}]: ")
+  answer = gets().chomp()
+  if answer == ""
+    confirmed = true
+  else
+    if File.directory?(answer)
+      confirmed = true
+      sbindir = answer
+    else
+      puts("  Sorry, the directory #{answer} was not found.\n\n")
+    end
+  end
+end until confirmed
+
+#______________________
+# install the executable
+exe = "mplex"
+targ = "#{sbindir}/#{exe}"
+FileUtils.cp("#{bindir}/#{exe}", targ)
+FileUtils.chown("root", "wheel", targ)
+FileUtils.chmod(0755, targ)
+puts(" " + `ls -l #{targ}`)
+puts("Done.")

data/rulesets/rules.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby -Ilib
+#!/usr/bin/ruby
 # run with command like:
 #    rulesets/rules.rb < /var/log/mail.log 3>missed.log 2>control.log > newevents.log
 # takes input from a log file and emits new events to newevents.log
@@ -15,8 +15,10 @@ Notify.emailTo = "me@myfirm.com"
 Notify.jabber_credentials("rec@gmail.com", "recret")
 Notify.jabberTo = "me@myfirm.com"
 
-# load rulesets
-require 'rulesets/postfix-rules'
-require 'rulesets/sample-rules'
+# load rulesets specified as arguments on the command line
+while ARGV[0]
+  require ARGV[0]
+  ARGV.shift()    # remove from ARGV so rulesets are *not* treated as STDIN
+end
 
 Correlator::start()

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rec
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 1
   - 1
-  - 0
-  version: 1.1.0
+  - 1
+  version: 1.1.1
 platform: ruby
 authors: 
 - Richard Kernahan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-19 00:00:00 Z
+date: 2012-09-30 00:00:00 Z
 dependencies: []
 
 description: "\t\tSifts through your log files in real time, using stateful intelligence to determine\n\
@@ -38,7 +38,9 @@ files:
 - lib/rec/state.rb
 - lib/rec/correlator.rb
 - lib/rec/notify.rb
+- lib/rec/install.rb
 - lib/string.rb
+- lib/mplex
 - rulesets/rules.rb
 - rulesets/sample-rules.rb
 - rulesets/postfix-rules.rb
@@ -51,7 +53,8 @@ files:
 homepage: http://rubygems.org/gems/rec
 licenses: []
 
-post_install_message: 
+post_install_message: "\n\n  To install the mplex executable issue the following command:\n\
+  \t$ sudo ruby -rubygems -e \"require 'rec/install'\"\n\n  "
 rdoc_options: 
 - --main
 - README