nagios_mklivestatus 0.0.3 → 0.0.9

data/lib/nagios_mklivestatus/stats/or.rb

@@ -0,0 +1,81 @@
+# This class is used to make a logical "OR" operator between two stats expressions.
+#
+# If one of the stats expression is also an "OR", 
+# it takes all the expressions of the operator as its own.
+#
+# Author::    Esco-lan Team  (mailto:team@esco-lan.org)
+# Copyright:: Copyright (c) 2012 GIP RECIA
+# License::   General Public Licence
+class Nagios::MkLiveStatus::Stats::Or < Nagios::MkLiveStatus::Stats
+  
+  include Nagios::MkLiveStatus
+  
+  #
+  # Create a new "OR" operator between left and right expressions.
+  #
+  # Those expressions must be of type Nagios::MkLiveStatus::Stats
+  #
+  def initialize(left_expr, right_expr)
+    if not left_expr.is_a? Nagios::MkLiveStatus::Stats or not right_expr.is_a? Nagios::MkLiveStatus::Stats
+      raise QueryException.new("The left and the right operand for an OR expression must be stats expressions.")
+    end
+    
+    @expressions = Array.new
+    if left_expr.is_a? Nagios::MkLiveStatus::Filter::Or
+      left_expr.get_expressions.each do |expr|
+        @expressions.push expr
+      end
+    else
+      @expressions.push left_expr
+    end
+    
+    if right_expr.is_a? Nagios::MkLiveStatus::Filter::Or
+      right_expr.get_expressions.each do |expr|
+        @expressions.push expr
+      end
+    else
+      @expressions.push right_expr
+    end
+
+  end
+  
+  #
+  # Return all the expressions under the "OR". It's used by 
+  # the new method in order to get all "OR" expressions into the same object.  
+  #
+  def get_expressions
+    return @expressions
+  end
+  
+  #
+  # Convert the current "OR" expression into a nagios query string
+  #  Stats: ...
+  #  Stats: ...
+  #  StatsOr: 2
+  #
+  def to_s
+    or_arr = []
+    @expressions.each do |expr|
+      or_arr.push expr.to_s
+    end
+    or_arr.push "StatsOr: #{@expressions.length}"
+    return or_arr.join("\n")
+  end
+  
+  # transform predicate to column name
+  # "left or right" with brackets if children
+  def to_column_name(has_parent=false)
+    or_arr = []
+    @expressions.each do |expr|
+      or_arr.push expr.to_column_name(true)
+    end
+    
+    column_name = or_arr.join(" or ")
+     
+    if has_parent
+      column_name = "( "+column_name+" )"
+    end
+    
+    return column_name
+  end
+end

data/lib/nagios_mklivestatus/stats.rb

@@ -0,0 +1,17 @@
+# This class is used to agregate all stats class into one module.
+#
+# It also provides the following stats expressions:
+# * Nagios::MkLiveStatus::Stats::Attr : standard attribute or field stats
+# * Nagios::MkLiveStatus::Stats::And : "AND" operator between two stats expressions
+# * Nagios::MkLiveStatus::Stats::Or : "OR" operator between two stats expressions
+#
+# Author::    Esco-lan Team  (mailto:team@esco-lan.org)
+# Copyright:: Copyright (c) 2012 GIP RECIA
+# License::   General Public Licence
+class Nagios::MkLiveStatus::Stats
+  
+  require File.join(File.dirname(__FILE__), File.basename(__FILE__, ".rb"), "attr")
+  require File.join(File.dirname(__FILE__), File.basename(__FILE__, ".rb"), "and")
+  require File.join(File.dirname(__FILE__), File.basename(__FILE__, ".rb"), "or")
+  
+end

data/lib/nagios_mklivestatus/wait/and.rb

@@ -0,0 +1,65 @@
+# This class is used to make a logical "AND" operator between two wait expressions.
+#
+# If one of the wait expression is also an "AND", 
+# it takes all the expressions of the operator as its own.
+#
+# Author::    Esco-lan Team  (mailto:team@esco-lan.org)
+# Copyright:: Copyright (c) 2012 GIP RECIA
+# License::   General Public Licence
+class Nagios::MkLiveStatus::Wait::And < Nagios::MkLiveStatus::Wait
+  
+  include Nagios::MkLiveStatus
+  
+  #
+  # Create a new "AND" operator between left and right expressions.
+  #
+  # Those expressions must be of type Nagios::MkLiveStatus::Wait
+  #
+  def initialize(left_expr, right_expr)
+    if not check_valid_condition(left_expr) or not check_valid_condition(right_expr)
+      raise QueryException.new("The left and the right operand for an OR expression must be valid wait conditions.")
+    end
+    
+    @expressions = Array.new
+    if left_expr.is_a? Nagios::MkLiveStatus::Wait::And
+      left_expr.get_expressions.each do |expr|
+        @expressions.push expr
+      end
+    else
+      @expressions.push left_expr
+    end
+    
+    if right_expr.is_a? Nagios::MkLiveStatus::Wait::And
+      right_expr.get_expressions.each do |expr|
+        @expressions.push expr
+      end
+    else
+      @expressions.push right_expr
+    end
+
+  end
+  
+  #
+  # Return all the expressions under the "AND". It's used by 
+  # the new method in order to get all "AND" expressions into the same object.  
+  #
+  def get_expressions
+    return @expressions
+  end
+  
+  #
+  # Convert the current "AND" expression into a nagios query string
+  #  WaitCondition: ...
+  #  WaitCondition: ...
+  #  WaitConditionAnd: 2
+  #
+  def to_s
+    and_arr = []
+    @expressions.each do |expr|
+      and_arr.push expr.to_s
+    end
+    and_arr.push "WaitConditionAnd: #{@expressions.length}"
+    return and_arr.join("\n")
+  end
+  
+end

data/lib/nagios_mklivestatus/wait/attr.rb

@@ -0,0 +1,59 @@
+# This class symbolise a wait condition unit. This unit represents a small wait condition predicate like, in the nagios query, this : 
+#  WaitCondition: host_name = name
+#
+# Author::    Esco-lan Team  (mailto:team@esco-lan.org)
+# Copyright:: Copyright (c) 2012 GIP RECIA
+# License::   General Public Licence
+class Nagios::MkLiveStatus::Wait::Attr < Nagios::MkLiveStatus::Wait
+  
+  include Nagios::MkLiveStatus
+  include Nagios::MkLiveStatus::QueryHelper::Comparator
+  
+  #
+  # Create the unit predicate with the column name, the operator use to compare, and the value
+  # [attr_name] name of the column
+  # [attr_comp] operator, one of the constant of the class
+  # [attr_value] the value to compare to
+  #
+  def initialize (attr_name, attr_comp, attr_value)
+    
+    list_comparator = get_all_comparators
+    
+    if attr_name == nil or attr_name.empty?
+      raise QueryException.new("The name of the attribute must be set in order to create the wait condition")
+    else
+      @attr_name = attr_name
+    end
+    
+    if list_comparator.index(attr_comp) == nil
+      raise QueryException.new("The comparator \"#{attr_comp}\" is not recognized.\n Please use one of : #{list_comparator.join(", ")}")
+    else
+      @attr_comp = attr_comp
+    end
+    
+    @attr_value = attr_value
+  end
+  
+  #
+  # Convert the Wait class to the nagios query string.
+  #
+  # Use the parameters to create a string corresponding to:
+  #  WaitCondition: name comp value
+  #
+  def to_s
+    if @attr_name == nil or @attr_name.empty?
+      raise QueryException.new("The wait condition cannot be converted into string because the name of the attribute is not set.")
+    end
+    
+    if @attr_comp == nil or @attr_comp.empty?
+      raise QueryException.new("The wait condition cannot be converted into string because the comparator of the attribute is not set.")
+    end
+    
+    if @attr_value == nil or @attr_value.empty?
+      return "WaitCondition: "+@attr_name+" "+@attr_comp 
+    end
+    
+    return "WaitCondition: "+@attr_name+" "+@attr_comp+" "+@attr_value;
+  end
+  
+end

data/lib/nagios_mklivestatus/wait/negate.rb

@@ -0,0 +1,49 @@
+# This class is used to make a logical "NOT" operator for the expression.
+#
+# Author::    Esco-lan Team  (mailto:team@esco-lan.org)
+# Copyright:: Copyright (c) 2012 GIP RECIA
+# License::   General Public Licence
+class Nagios::MkLiveStatus::Wait::Negate < Nagios::MkLiveStatus::Wait
+  
+  include Nagios::MkLiveStatus
+  
+  #
+  # Create a new "Not" operator to the expression.
+  #
+  # Those expressions must be of type Nagios::MkLiveStatus::Wait
+  #
+  def initialize(expr)
+    if not check_valid_condition expr
+      raise QueryException.new("The operand for a NEGATE expression must be one valid wait condition.")
+    end
+    
+    @expression = expr
+    
+  end
+  
+  #
+  # Return the expression under the "Negate". It's used by 
+  # the to_s method in order to remove the overflow of Negate expression.  
+  #
+  def get_expression
+    return @expression
+  end
+  
+  #
+  # Convert the current "Negate" expression into a nagios query string.
+  #
+  # If the sub expression is also a Negate, it returns the sub-sub expression without negating it.
+  #  WaitCondition: ...
+  #  WaitConditionNegate:
+  #
+  def to_s
+    if @expression.is_a? Nagios::MkLiveStatus::Wait::Negate
+      return @expression.get_expression.to_s
+    else
+      negate_arr = []
+      negate_arr.push @expression.to_s
+      negate_arr.push "WaitConditionNegate: "
+      return negate_arr.join("\n")
+    end
+  end
+end

data/lib/nagios_mklivestatus/wait/object.rb

@@ -0,0 +1,29 @@
+# This class is used to make a wait object.
+#
+# Author::    Esco-lan Team  (mailto:team@esco-lan.org)
+# Copyright:: Copyright (c) 2012 GIP RECIA
+# License::   General Public Licence
+class Nagios::MkLiveStatus::Wait::Object < Nagios::MkLiveStatus::Wait
+  
+  include Nagios::MkLiveStatus
+  
+  #
+  # Create a new wait object expression.
+  #
+  def initialize(name)
+    if not name
+      raise QueryException.new("The object value must be set for the wait operation.")
+    end
+    
+    @name = name
+    
+  end
+  
+  #
+  # Convert the current object expression into a nagios query string.
+  #  WaitObject: ...
+  #
+  def to_s
+     return "WaitObject: "+@name
+  end
+end

data/lib/nagios_mklivestatus/wait/or.rb

@@ -0,0 +1,64 @@
+# This class is used to make a logical "OR" operator between two wait condition expressions.
+#
+# If one of the wait condition expression is also an "OR", 
+# it takes all the expressions of the operator as its own.
+#
+# Author::    Esco-lan Team  (mailto:team@esco-lan.org)
+# Copyright:: Copyright (c) 2012 GIP RECIA
+# License::   General Public Licence
+class Nagios::MkLiveStatus::Wait::Or < Nagios::MkLiveStatus::Wait
+  
+  include Nagios::MkLiveStatus
+  
+  #
+  # Create a new "OR" operator between left and right expressions.
+  #
+  # Those expressions must be of type Nagios::MkLiveStatus::Wait
+  #
+  def initialize(left_expr, right_expr)
+    if not check_valid_condition(left_expr) or not check_valid_condition(right_expr)
+      raise QueryException.new("The left and the right operand for an OR expression must be valid wait conditions.")
+    end
+    
+    @expressions = Array.new
+    if left_expr.is_a? Nagios::MkLiveStatus::Wait::Or
+      left_expr.get_expressions.each do |expr|
+        @expressions.push expr
+      end
+    else
+      @expressions.push left_expr
+    end
+    
+    if right_expr.is_a? Nagios::MkLiveStatus::Wait::Or
+      right_expr.get_expressions.each do |expr|
+        @expressions.push expr
+      end
+    else
+      @expressions.push right_expr
+    end
+
+  end
+  
+  #
+  # Return all the expressions under the "OR". It's used by 
+  # the new method in order to get all "OR" expressions into the same object.  
+  #
+  def get_expressions
+    return @expressions
+  end
+  
+  #
+  # Convert the current "OR" expression into a nagios query string
+  #  WaitCondition: ...
+  #  WaitCondition: ...
+  #  WaitConditionOr: 2
+  #
+  def to_s
+    or_arr = []
+    @expressions.each do |expr|
+      or_arr.push expr.to_s
+    end
+    or_arr.push "WaitConditionOr: #{@expressions.length}"
+    return or_arr.join("\n")
+  end
+end

data/lib/nagios_mklivestatus/wait/timeout.rb

@@ -0,0 +1,30 @@
+# This class is used to make a wait timeout.
+#
+# Author::    Esco-lan Team  (mailto:team@esco-lan.org)
+# Copyright:: Copyright (c) 2012 GIP RECIA
+# License::   General Public Licence
+class Nagios::MkLiveStatus::Wait::Timeout < Nagios::MkLiveStatus::Wait
+  
+  include Nagios::MkLiveStatus
+  
+  #
+  # Create a new wait timeout expression.
+  # _Timeout in millisecond_
+  #
+  def initialize(timeout)
+    if not timeout
+      raise QueryException.new("The timeout must be set for the wait operation.")
+    end
+    
+    @timeout = timeout
+    
+  end
+  
+  #
+  # Convert the current timeout expression into a nagios query string.
+  #  WaitTimeout: ...
+  #
+  def to_s
+     return "WaitTimeout: "+@timeout
+  end
+end

data/lib/nagios_mklivestatus/wait/trigger.rb

@@ -0,0 +1,31 @@
+# This class is used to make a wait trigger.
+#
+# Author::    Esco-lan Team  (mailto:team@esco-lan.org)
+# Copyright:: Copyright (c) 2012 GIP RECIA
+# License::   General Public Licence
+class Nagios::MkLiveStatus::Wait::Trigger < Nagios::MkLiveStatus::Wait
+  
+  include Nagios::MkLiveStatus
+  include Nagios::MkLiveStatus::QueryHelper::Trigger
+  
+  #
+  # Create a new wait trigger expression.
+  #
+  def initialize(trigger=ALL)
+    list_triggers = get_all_triggers
+    if not list_triggers.include? trigger
+      raise QueryException.new("The trigger value must be one of #{list_triggers.join(', ')}")
+    end
+    
+    @trigger = trigger
+    
+  end
+  
+  #
+  # Convert the current trigger expression into a nagios query string.
+  #  WaitTrigger: ...
+  #
+  def to_s
+     return "WaitTrigger: "+@trigger
+  end
+end

data/lib/nagios_mklivestatus/wait.rb

@@ -0,0 +1,32 @@
+# This class is used to agregate all waits class into one module.
+#
+# It also provides the following wait expressions:
+# * Nagios::MkLiveStatus::Wait::Attr : standard attribute or field wait condition
+# * Nagios::MkLiveStatus::Wait::And : "AND" operator between two wait conditions expressions
+# * Nagios::MkLiveStatus::Wait::Or : "OR" operator between two wait conditions expressions
+# * Nagios::MkLiveStatus::Wait::Negate : "NOT" operator for the last wait condition expressions
+# * Nagios::MkLiveStatus::Wait::Object : symbolize the wait object
+# * Nagios::MkLiveStatus::Wait::Trigger : wait trigger
+# * Nagios::MkLiveStatus::Wait::Timeout : timeout of the wait
+#
+# Author::    Esco-lan Team  (mailto:team@esco-lan.org)
+# Copyright:: Copyright (c) 2012 GIP RECIA
+# License::   General Public Licence
+class Nagios::MkLiveStatus::Wait
+  
+  require File.join(File.dirname(__FILE__), File.basename(__FILE__, ".rb"), "attr")
+  require File.join(File.dirname(__FILE__), File.basename(__FILE__, ".rb"), "and")
+  require File.join(File.dirname(__FILE__), File.basename(__FILE__, ".rb"), "or")
+  require File.join(File.dirname(__FILE__), File.basename(__FILE__, ".rb"), "negate")
+  require File.join(File.dirname(__FILE__), File.basename(__FILE__, ".rb"), "trigger")
+  require File.join(File.dirname(__FILE__), File.basename(__FILE__, ".rb"), "object")
+  require File.join(File.dirname(__FILE__), File.basename(__FILE__, ".rb"), "timeout")
+  
+protected
+  #
+  # Check if the expression is a valid wait condition (WaitCondition, WaitConditionAnd, WaitConditionOr)
+  def check_valid_condition(expression)
+    expression.is_a? Nagios::MkLiveStatus::Wait::And or expression.is_a? Nagios::MkLiveStatus::Wait::Or or expression.is_a? Nagios::MkLiveStatus::Wait::Attr
+  end
+  
+end