log2mail 0.0.1.pre3 → 0.0.1.pre4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3636434bfe17fe625cb2e6077f816d1a623b85bc
-  data.tar.gz: de33d7d97f5f51641d373f3b3197f838b6a61b93
+  metadata.gz: bdf651d2af53d14c8f36ea64233f8db4116c055d
+  data.tar.gz: 1c35a2f8dc2df19d6635b66d24c279029bcff909
 SHA512:
-  metadata.gz: b30c40a090d017da981ccfef1ce53edadcb0d4f89e4a42e20fc59596febf2988517694fc98d394459be169d759027e4f585709b253cdfb4ac6c7e5969f465c24
-  data.tar.gz: d2a55f7581c4ce4ab8da660cf147c064238a9bfa5c6c1bbf8f03da16dd59b2907a66973b92d84acca22cf09c2a4ff2e70968dad285c70026e93685f3fead2016
+  metadata.gz: cba00ca0b65e5f87f434450f44bbef5e17e94fdfb8c144e4f73ce002648425e96ba39f5a2d63ba9c7eac0d82df28ba3e15be46576629a4053818ccfd12d60a13
+  data.tar.gz: 5e640a298954ebf3fae7745f86ea478f9f4ff8f56e0d71bd8284f5ddd8feef13c1e530d2735ef8b8395e9f2a21f99f2c6e417f143adcce5152dd132d396f2889

data/{INSTALL → INSTALL.md}

@@ -4,6 +4,7 @@ log2mail.rb Installation
 Requirements
 ------------
 
+* Linux
 * Ruby 1.9.3
 
 Debian 7 (and higher)
@@ -25,6 +26,7 @@ Create a configuration file, e.g. at `/usr/local/etc/log2mail.conf`:
 
     cat > /usr/local/etc/log2mail.conf <<EOF
     defaults
+      sendmail = /usr/sbin/sendmail
       mailto = your@mail.address
     file = /tmp/test.log
       pattern = test

data/README.md

@@ -9,7 +9,7 @@ log2mail.rb(1) -- monitors (log) files for patterns and reports hits by mail
 
 `log2mail.rb` helps having an eye on your systems' log files.  It efficiently monitors multiple files and reports as soon as specified (regular expression) patterns match.
 
-On startup, `log2mail.rb` opens all files on the 'watch list' and seeks to EOF.  All new data are parsed about once a minute (see `--sleeptime`). <!-- If necessary, i.e. when multiline patterns are set for the file, every new data is put into a fixed-size buffer.  The buffer is rolled over when it gets full. --> Matched patterns are reported to the configured mail address(es) (see `mailto` configuration option).
+On startup, `log2mail.rb` opens all files on the 'watch list' and seeks to EOF.  All new data are parsed about once a minute (see `--sleeptime`). Matched patterns are reported to the configured mail address(es) (see `mailto` configuration option).
 
 Log files are reopened automatically when rotated.
 

data/features/log2mail_configurations/config_1

@@ -1,7 +1,7 @@
 # old-style syntax
 defaults
-  mailto   = recipient@test.itstrauss.eu
   fromaddr = log2mail
+  mailto   = recipient@test.itstrauss.eu
 file = test.log
   pattern = string pattern
   pattern = /regexp pattern/

data/lib/ext/string.rb

@@ -20,4 +20,10 @@ class String
       rxp
     end
   end
+
+  def pluralize
+    return self if self.to_s[-1] == 's'
+    (self.to_s + 's')
+  end
+
 end

data/lib/ext/symbol.rb

@@ -0,0 +1,7 @@
+class Symbol
+
+  def pluralize
+    self.to_s.pluralize.to_sym
+  end
+
+end

data/lib/log2mail.rb

@@ -1,5 +1,5 @@
 %w{ main mail terminal-table }.each {|r| require r}
-%w{ kernel string main }.each {|r| require_relative "ext/#{r}"}
+%w{ kernel string symbol main }.each {|r| require_relative "ext/#{r}"}
 begin
   require 'syslog/logger'
 rescue LoadError

data/lib/log2mail/config.rb

@@ -1,216 +1,15 @@
 module Log2mail
-  class Config
-
-    class <<self
-      def parse_config(config_path)
-        Log2mail::Config.new(config_path)
-        # pp config.config
-        # config.files.each do |f|
-        #   puts "File: #{f}"
-        #   config.patterns_for_file(f).each do |pattern|
-        #     puts "  Pattern: #{pattern}; mailto: " + config.mailtos_for_pattern( f, pattern ).join(', ')
-        #   end
-        # end
-      end
-    end
-
-    # attr_reader :config
-
+  module Config
     INT_OPTIONS = [:sendtime, :resendtime, :maxlines]
     STR_OPTIONS = [:fromaddr, :sendmail]
     PATH_OPTIONS = [:template]
-
-    def initialize(config_paths)
-      $logger.debug "Reading configuration from #{config_paths}"
-      @config_paths = Array(config_paths)
-      expand_paths
-      read_configuration
-      validate_configuration
-    end
-
-    # returns all the paths of all files needed to be watched
-    def files
-      @config.keys - [:defaults]
-    end
-
-    def file_patterns
-      h = {}
-      files.each do |file|
-        h[file] = patterns_for_file(file)
-      end
-      h
-    end
-
-    def patterns_for_file( file )
-      Hash(@config[file][:patterns]).keys + \
-      Hash(defaults[:patterns]).keys
-    end
-
-    def mailtos_for_pattern( file, pattern )
-      m = []
-      m.concat Hash( config_file_pattern(file, pattern)[:mailtos] ).keys
-      m.concat Hash(Hash(Hash(defaults[:patterns])[pattern])[:mailtos]).keys
-      m.concat Array(defaults[:mailtos]) if m.empty?
-      m.uniq
-    end
-
-    def settings_for_mailto( file, pattern, mailto )
-      h = defaults.reject {|k,v| k==:mailtos}
-      h.merge config_file_mailto(file, pattern, mailto)
-    end
-
-    def defaults
-      Hash(@config[:defaults])
-    end
-
-    def formatted( show_effective )
-      Terminal::Table.new do |t|
-        settings_header = show_effective ? 'Effective Settings' : 'Settings'
-        t << ['File', 'Pattern', 'Recipient', settings_header]
-        t << :separator
-        files.each do |file|
-          patterns_for_file(file).each do |pattern|
-            mailtos_for_pattern(file, pattern).each do |mailto|
-              settings = []
-              if show_effective
-                settings_for_mailto(file, pattern, mailto).each_pair \
-                  { |k,v| settings << '%s=%s' % [k,v] }
-              else
-                config_file_mailto(file, pattern, mailto).each_pair \
-                  { |k,v| settings << '%s=%s' % [k,v] }
-              end
-              t.add_row [file, pattern, mailto, settings.join($/)]
-            end
-          end
-        end
-      end
-    end
-
-    private
-
-    def config_file(file)
-      Hash(@config[file])
-    end
-
-    def config_file_pattern(file, pattern)
-      Hash( Hash( config_file(file)[:patterns] )[pattern] )
-    end
-
-    def config_file_mailtos(file, pattern)
-      Hash( config_file_pattern(file, pattern)[:mailtos] )
-    end
-
-    def config_file_mailto(file, pattern, mailto)
-      Hash( config_file_mailtos(file, pattern)[mailto] )
-    end
-
-    def expand_paths
-      expanded_paths = []
-      @config_paths.each do |path|
-        if ::File.directory?(path)
-          expanded_paths.concat Dir.glob( ::File.join( path, '*[^~#]' ) )
-        else
-          expanded_paths << path
-        end
-      end
-      @config_paths = expanded_paths
-    end
-
-    # tries to follow original code at https://github.com/lordlamer/log2mail/blob/master/config.cc#L192
-    def read_configuration
-      @config = {}
-      @config_paths.each do |file|
-        @section = nil; @pattern = nil; @mailto = nil
-        # section, pattern, mailto are reset for every file (but not when included by 'include')
-        parse_file( file )
-      end
-    end
-
-    def parse_file( filename )
-      IO.readlines(filename).each_with_index do |line, lineno|
-        parse(filename, line, lineno + 1)
-      end
-    rescue Errno::ENOENT
-      fail Error, "Configuration file or directory not found (or not readable): #{filename}"
-    end
-
-    def parse(file, line, lineno)
-      line.strip!
-      return if line =~ /^#/
-      return if line =~ /^$/
-      line =~ /^(\S+)\s*=?\s*"?(.*?)"?(\s*#.*)?$/  # drop double quotes on right hand side; drop comments
-      key, value = $1.to_sym, $2.strip
-      if key == :include # include shall work everywhere
-        parse_file( ::File.join(Pathname(file).parent, value) )
-        return
-      end
-      if key == :defaults and value.empty?  # section: specifies top level; must be 'defaults' or 'file'
-        @section = key
-        @pattern = nil; @mailto = nil
-        fail Error, "Invalid section. Section 'defaults' already specified." if @config[@section]
-        @config[@section] = {}
-      elsif key == :file
-        @section = value
-        @pattern = nil; @mailto = nil
-        @config[@section] ||= {}
-      elsif key == :pattern # must come inside 'file' (or 'defaults')
-        # fail "Invalid section. All statements must appear after 'defaults' or 'file=...'" unless @section
-        @pattern = value; @mailto = nil
-        @config[@section][:patterns] ||= {}
-        warning { "Redefining pattern section '#{value}' which has been defined already for '#{@section}'." } \
-          if @config[@section][:patterns][value]
-        @config[@section][:patterns][value] = {}
-      elsif key == :mailto and @section != :defaults # must come inside 'pattern' (or 'defaults')
-        fail Error, "'mailto' statements only allowed inside 'pattern' or 'defaults'." unless @pattern
-        @mailto = value
-        @config[@section][:patterns][@pattern][:mailtos] ||= {}
-        warning { "Redefining mailto section '#{value}' which has been defined already for '#{@section}'." } \
-          if @config[@section][:patterns][@pattern][:mailtos][value]
-        @config[@section][:patterns][@pattern][:mailtos][value] = {}
-      else # everything else must come inside 'defaults' or 'mailto'
-        fail Error, "'#{key}' must be set within 'defaults' or 'mailto'." unless @section == :defaults or @mailto
-        if INT_OPTIONS.include?(key)
-          value = value.to_i
-        elsif STR_OPTIONS.include?(key)
-        elsif PATH_OPTIONS.include?(key)
-          value = ::File.expand_path( value, Pathname(file).parent ) unless Pathname(value).absolute?
-        elsif key == :mailto # special handling for 'mailto' in 'defaults' section
-          @config[:defaults][:mailtos] ||= []
-          @config[:defaults][:mailtos] << value
-          return # skip the 'mailto' entry itself
-        else
-          fail Error, "'#{key}' is an unknown configuration statement."
-        end
-        if @section == :defaults and !@pattern and !@mailto
-          warning { "Redefining value for '#{key}'." } if @config[@section][key]
-          @config[@section][key] = value
-        else
-          warning { "Redefining value for '#{key}'." } \
-            if @config[@section][:patterns][@pattern][:mailtos][@mailto][key]
-          @config[@section][:patterns][@pattern][:mailtos][@mailto][key] = value
-        end
-      end
-    rescue
-      fail Error, "#{file} (line #{lineno}): #{$!.message}#$/[#{$!.class} at #{$!.backtrace.first}]"
-    end
-
-    def validate_configuration
-      files.each do |file|
-        patterns_for_file(file).each do |pattern|
-          mailtos = mailtos_for_pattern(file, pattern)
-          $logger.warn "Pattern #{file}:#{pattern} has no recipients." if mailtos.empty?
-        end
-      end
-      # FIXME: empty configuration should cause FATAL error
-      # TODO: illegal regexp pattern should cause ERROR
-    end
-
-    def warning(&block)
-      file = block.binding.eval('file')
-      lineno = block.binding.eval('lineno')
-      message = block.call
-      $logger.warn "#{file} (line #{lineno}): #{message}#$/[at #{caller.first}]"
-    end
-
+    ATTRIBUTES = INT_OPTIONS + STR_OPTIONS + PATH_OPTIONS
   end
 end
+
+require_relative 'config/config'
+require_relative 'config/attribute'
+require_relative 'config/section'
+require_relative 'config/parser'
+require_relative 'config/config_file_snippet'
+require_relative 'config/config_file_handler'

data/lib/log2mail/config/attribute.rb

@@ -0,0 +1,21 @@
+module Log2mail
+  module Config
+    class Attribute
+      attr_reader :name, :value
+      def initialize( name, value )
+        @name  = name.to_sym
+        @value = value
+      end
+      def ==(other)
+        self.name == other.name and self.value == other.value
+      end
+      def inspect
+        'Attribute %s = %s' % [@name.inspect, @value.inspect]
+      end
+      def tree
+        {self.name => self.value}
+        # self.value
+      end
+    end
+  end
+end

data/lib/log2mail/config/config.rb

@@ -0,0 +1,45 @@
+module Log2mail
+  module Config
+    class Config
+      attr_reader :sections
+      def initialize( sections = [] )
+        @sections = merge sections
+      end
+      def ==(other)
+        return false unless other.instance_of?(self.class)
+        self.sections == other.sections
+      end
+      def inspect
+        'Config: %s' % [@sections.inspect]
+      end
+      def tree
+        h = {}
+        @sections.inject(h) do |h, a|
+          if a.name==:defaults
+            h[:defaults] = a.tree
+          else
+            a.tree.each_pair {|k,v| ( h[a.name.pluralize.to_sym] ||= {} )[k] = v }
+          end
+          h
+        end
+        h
+      end
+
+      private
+
+      # FIXME: needs specing
+      def merge( sections )
+        sections = sections.compact.find_all{ |s| s.respond_to?(:name) }
+        names = sections.map(&:name).uniq
+        names.map do |name|
+          secs_with_same_name = sections.find_all{ |sec| sec.name == name }
+          their_uniq_values = secs_with_same_name.map(&:value).uniq
+          their_uniq_values.map{ |val| secs_with_same_name.find_all{ |s| s.value == val }.reduce(:+) }
+        end.flatten(1)
+      rescue NoMethodError
+        fail "Invalid configuration: #{$!.inspect}"
+      end
+
+    end
+  end
+end

data/lib/log2mail/config/config_file_handler.rb

@@ -0,0 +1,142 @@
+module Log2mail
+  module Config
+    class ConfigFileHandler
+
+      class <<self
+        def parse_config(config_path)
+          new(config_path)
+        end
+      end
+
+      def initialize(config_paths)
+        $logger.debug "Reading configuration from #{config_paths}"
+        @config_paths = Array(config_paths)
+        expand_paths
+        @config = Parser.new.parse_snippets( raw ).tree
+        validate_configuration
+      end
+
+      def expand_paths
+        expanded_paths = []
+        @config_paths.each do |path|
+          if ::File.directory?(path)
+            expanded_paths.concat Dir.glob( ::File.join( path, '*[^~#]' ) )
+          else
+            expanded_paths << path
+          end
+        end
+        @config_paths = expanded_paths
+      end
+
+      def raw
+        @config_paths.map do |file|
+          ConfigFileSnippet.new( IO.read(file), file )
+        end
+      end
+
+      # returns all the paths of all files needed to be watched
+      def files
+        Hash(@config[:files]).keys
+      end
+
+      # FIXME: specs
+      def file_patterns
+        h = {}
+        files.each do |file|
+          h[file] = patterns_for_file(file)
+        end
+        h
+      end
+
+      # returns the default settings
+      def defaults
+        Hash(@config[:defaults])
+      end
+
+      # returns all patterns for file
+      def patterns_for_file( file )
+        Hash(config_file(file)[:patterns]).keys + \
+        Hash(defaults[:patterns]).keys
+      end
+
+      def mailtos_for_pattern( file, pattern )
+        m = []
+        m.concat Hash( config_file_pattern(file, pattern)[:mailtos] ).keys
+        m.concat Hash(Hash(Hash(defaults[:patterns])[pattern])[:mailtos]).keys
+        m.concat Hash(defaults[:mailtos]).keys if m.empty?
+        m.uniq
+      end
+
+      def settings_for_mailto( file, pattern, mailto )
+        h = defaults.reject {|k,v| k==:mailtos}
+        h.merge config_file_mailto(file, pattern, mailto)
+      end
+
+
+
+      def formatted( show_effective = false )
+        Terminal::Table.new do |t|
+          settings_header = show_effective ? 'Effective Settings' : 'Settings'
+          t << ['File', 'Pattern', 'Recipient', settings_header]
+          t << :separator
+          files.each do |file|
+            patterns_for_file(file).each do |pattern|
+              mailtos_for_pattern(file, pattern).each do |mailto|
+                settings = []
+                if show_effective
+                  settings_for_mailto(file, pattern, mailto).each_pair \
+                    { |k,v| settings << '%s=%s' % [k,v] }
+                else
+                  config_file_mailto(file, pattern, mailto).each_pair \
+                    { |k,v| settings << '%s=%s' % [k,v] }
+                end
+                t.add_row [file, pattern, mailto, settings.join($/)]
+              end
+            end
+          end
+        end
+      end
+
+
+
+      private
+
+      def config_file(file)
+        Hash(Hash(@config[:files])[file])
+      end
+
+      def config_file_pattern(file, pattern)
+        Hash( Hash( config_file(file)[:patterns] )[pattern] )
+      end
+
+      def config_file_mailtos(file, pattern)
+        config_file_pattern(file, pattern)[:mailtos] || {}
+      end
+
+      def config_file_mailto(file, pattern, mailto)
+        config_file_mailtos(file, pattern)[mailto] || {}
+      end
+
+
+      def validate_configuration
+        files.each do |file|
+          patterns_for_file(file).each do |pattern|
+            mailtos = mailtos_for_pattern(file, pattern)
+            $logger.warn "Pattern #{file}:#{pattern} has no recipients." if mailtos.empty?
+          end
+        end
+
+        $logger.warn "Attributes for a global default recipient specified. This may or may not be what you want. Consult `gem man log2mail` if unsure." \
+          if !defaults[:mailtos].nil? and defaults[:mailtos].any?{|k,v| !v.empty? }
+
+        $logger.warn "Attributes for a global default pattern specified. This may or may not be what you want. Consult `gem man log2mail` if unsure." \
+          if !defaults[:patterns].nil? and defaults[:patterns].any?{|k,v| !v.empty? }
+
+        # FIXME: empty configuration should cause FATAL error
+        # TODO: illegal regexp pattern should cause ERROR
+      end
+
+
+    end
+  end
+end