zabcon 0.0.370 → 0.0.392

data/libs/zabcon_core.rb

@@ -20,8 +20,8 @@
 
 ##########################################
 # Subversion information
-# $Id: zabcon_core.rb 370 2011-12-22 05:51:45Z nelsonab $
-# $Revision: 370 $
+# $Id: zabcon_core.rb 384 2012-04-23 04:50:17Z nelsonab $
+# $Revision: 384 $
 ##########################################
 
 #require 'libs/utility_items'
@@ -58,38 +58,8 @@ class ZabconCore
     debug(5,:msg=>"Setting up help")
     CommandHelp.setup("english")
 
-    #TODO Remove reference to ArgumentProcessor when new command objects in use
-    debug(5,:msg=>"Setting up ArgumentProcessor")
-
-    loaded_session=false
-    begin
-      if !env["server"].nil? && !env["session_file"].nil? &&
-          !env["session_file"].empty?
-        path=File.expand_path(env["session_file"])
-        puts "Attempting to load previous session key from #{env["session_file"]}" if env["echo"]
-        yaml=YAML::load(File.open(path))
-        loaded_session=ZabbixServer.instance.use_auth(yaml["auth"])
-        puts "#{env["server"]} connected"  if env["echo"]
-        puts "API Version: #{ZabbixServer.instance.version}"  if env["echo"]
-      end
-    rescue Errno::ENOENT
-      puts "Failed to load previous session key" if env["echo"]
-    rescue ZbxAPI_ExceptionLoginPermission
-      puts "Failed to load previous session key" if env["echo"]
-    end
-
-    if !loaded_session && !env["server"].nil? &&
-      !env["username"].nil? && !env["password"].nil?
-      puts "Found valid login credentials, attempting login"  if env["echo"]
-      begin
-        ZabbixServer.instance.login
-
-      rescue ZbxAPI_ExceptionBadAuth => e
-        puts e.message
-      rescue ZbxAPI_ExceptionLoginPermission
-        puts "Error Invalid login or no API permissions."
-      end
-    end
+    server_login unless env["no_login"]
+    env.delete("no_login") if env["no_login"]
 
     debug(5,:msg=>"Setting up prompt")
     @debug_prompt=false
@@ -166,6 +136,58 @@ class ZabconCore
     debug(5,:msg=>"Setup complete")
   end
 
+  #TODO clean up and streamline with multiple server capabilities
+  def server_login
+    loaded_session=false
+    begin
+      if !env["session_file"].nil? && !env["session_file"].empty?
+        path=File.expand_path(env["session_file"])
+#        puts "Attempting to load previous session keys from #{env["session_file"]}" if env["echo"]
+        yaml=YAML::load(File.open(path))
+        if yaml["auth"]
+          yaml["auth"].each {|k,v|
+            if v.nil?  #cleanup for old auth file
+              k="global"
+              v=k
+            end
+            ServerCredentials.instance[k]["auth"]=v
+          }
+        end
+        credentials=ServerCredentials.instance[env["default_server"]]
+        if credentials["auth"]
+          puts "Attempting to use previous key" if env["echo"]
+          loaded_session=ZabbixServer.instance.use_auth(credentials)
+          puts "#{env["server"]} connected"  if env["echo"]
+          puts "API Version: #{ZabbixServer.instance.version}"  if env["echo"]
+        end
+      end
+    rescue Errno::ECONNREFUSED, Errno::ENOENT, ZbxAPI_ExceptionLoginPermission
+      puts "Failed to load previous session key" if env["echo"]
+#      return
+    end
+
+
+    credentials=ServerCredentials.instance[env["default_server"]] if credentials.nil?
+
+    if !loaded_session && !credentials["server"].nil? &&
+      !credentials["username"].nil? && !credentials["password"].nil?
+      puts "Found valid login credentials, attempting login"  if env["echo"]
+      begin
+
+        #
+        ZabbixServer.instance.login(credentials)
+
+      rescue ZbxAPI_ExceptionBadAuth => e
+        puts e.message
+      rescue ZbxAPI_ExceptionLoginPermission
+        puts "Error Invalid login or no API permissions."
+      rescue ZbxAPI_ExceptionBadServerUrl
+        puts "Error connecting to server"   #TODO Fix message to show hostname
+      end
+    end
+
+  end
+
   def load_command_path(path,base_path=nil,show_load=nil)
     base_path||="~"
     load_path=nil
@@ -216,7 +238,28 @@ class ZabconCore
           #tokens=ExpressionTokenizer.new(line)
           tokens=CommandTokenizer.new(line)
 
-          tokens.delete_if {|item| item.kind==:comment }
+#          tokens.delete_if {|item| item.kind==:comment }
+          tokens.map!{|item|
+            case item.kind
+              when :comment
+                item=nil
+              when :variable
+                var_name=item.value[1..-1]
+                if var_name=="auth"
+                  item.set_value(ServerCredentials.instance[env["default_server"]]["auth"])
+                elsif env[var_name]
+                  item.set_value(env[var_name])
+                elsif vars[var_name]
+                  item.set_value(vars[var_name])
+                else
+                  raise ZbxAPI_ParameterError.new("Unknown Variable #{item.value}")
+                end
+                item
+              else
+                item
+            end
+          }.compact!
+
           next if tokens.nil? || tokens.first.kind==:end ||
               (tokens.first.kind==:whitespace && tokens[1].kind==:end)
           debug(6, :var=>line, :msg=>"Input from user")
@@ -292,6 +335,7 @@ class ZabconCore
   end
 
 #
+# TODO: Fix XML Import capability to work again.
 # Import config from an XML file:
 #
   def do_import(input)

data/libs/zabcon_globals.rb

@@ -18,8 +18,8 @@
 
 ##########################################
 # Subversion information
-# $Id: zabcon_globals.rb 325 2011-09-26 08:57:00Z nelsonab $
-# $Revision: 325 $
+# $Id: zabcon_globals.rb 372 2011-12-22 08:49:30Z nelsonab $
+# $Revision: 372 $
 ##########################################
 
 #------------------------------------------------------------------------------
@@ -34,6 +34,7 @@ require 'zbxapi/zdebug'
 
 require 'singleton'
 require 'parseconfig'
+require 'pp'
 
 #This class is for containing responses from the Command tree
 class Response
@@ -101,6 +102,10 @@ class GlobalsBase
     end
   end
 
+  def select_keys(keys)
+    @hash.select_keys(keys)
+  end
+
   def delete(key)
     @hash.delete(key)
   end
@@ -132,123 +137,14 @@ class GlobalVars < GlobalsBase
 
 end
 
-class EnvVars < GlobalsBase
-
-  class NoConfig < Exception
-  end
-
+class ServerCredentials < GlobalsBase
   def initialize
     super()
   end
+end
 
-  #overrides is a hash of options which will override what is found in the config file.
-  #useful for command line options.
-  #if there is a hash called "config_file" this will override the default config file.
-  def load_config(overrides={})
-    begin
-      config_file = overrides["config_file"].nil? ? self["config_file"] : overrides["config_file"]
-
-      if config_file==:default
-        home_default=File::expand_path("~/zabcon.conf")
-        if File::exists?("zabcon.conf")
-          config_file="zabcon.conf"
-        elsif File::exists?(home_default)
-          config_file=home_default
-          self["config_file"]=home_default
-        else
-          raise NoConfig
-        end
-      end
-
-      config = overrides["load_config"]==false ?   # nil != false
-          {} : ParseConfig.new(config_file).params
-
-
-      # If we are not loading the config use an empty hash
-    rescue Errno::EACCES
-      if !(config_file=="zabcon.conf" and !File::exists?(config_file))
-        puts "Unable to access configuration file: #{config_file}"
-      end
-      config={}
-    rescue NoConfig
-      puts "Unable to find a default configuration file"
-      config={}
-    end
-
-    config.merge!(overrides)  # merge the two option sets together but give precedence
-                              # to command line options
-
-    config.each_pair { |k,v|
-      self[k]=v
-    }
-
-
-#    debug(6,params)
-#
-#    #Setup a local OpenStruct to copy potentially passed in OpenStruct
-#    #rather than query every time weather or not params is an OpenStruct
-#    localoptions=OpenStruct.new
-#
-#    env=EnvVars.instance  # Instantiate the global EnvVars
-#
-#    if params.nil? or params.empty?  # nil or empty, use conffile
-#      fname=@conffile
-#    elsif params.class==OpenStruct   # use OpenStruct value or conffile
-#      if params.configfile.nil?
-#        fname=@conffile
-#      else
-#        fname=params.configfile
-#        localoptions=params  # Since we have an OpenStruct passed in let's setup
-#                             # our local OpenStruct variable for use later
-#      end
-#    elsif params.class==Hash  # use Hash[:filename] or raise an exception
-#      if params[:filename].nil?
-#        raise ZabconError.new("Expected a hash with the key 'filename'")
-#      else
-#        fname=params[:filename]
-#      end
-#    else  # If we get here something went wrong.
-#      raise ZabconError.new("OH NO!!!  Received something unexpected in do_load_config.  Try again with debug level 6.")
-#    end
-#
-#    begin
-#      config=ParseConfig.new(fname).params
-#      debug(1,config)
-#
-#      if !config["debug"].nil?
-#        # If the command line option debug was not passed in use the config file
-#        env["debug"]=config["debug"].to_i if localoptions.debug.nil?
-#      end
-#
-#      if !config["server"].nil? and !config["username"].nil? and !config["password"].nil? then
-#        do_login({:server=>config["server"], :username=>config["username"],:password=>config["password"]})
-#      else
-#        puts "Missing one of the following, server, username or password or bad syntax"
-#      end
-#
-#      if !config["lines"].nil?
-#        env["sheight"]=config["lines"].to_i
-#      end
-#
-#      if !config["language"].nil?
-#        env["language"]=config["language"]
-#      end
-#
-#    rescue Errno::EACCES
-#      puts "Unable to open file #{fname}"
-#    rescue ZbxAPI_GeneralError => e
-#      puts "An error was received from the Zabbix server"
-#      if e.message.class==Hash
-#        puts "Error code: #{e.message["code"]}"
-#        puts "Error message: #{e.message["message"]}"
-#        puts "Error data: #{e.message["data"]}"
-#        retry
-#      else
-#        puts "Error: #{e.message}"
-#        e.attempt_retry
-#      end
-#    end
+class EnvVars < GlobalsBase
+  def initialize
+    super()
   end
-
-
 end

data/zabcon.conf.default

@@ -1,6 +1,7 @@
-server=http://localhost
-username=Admin
-password=zabbix
+#Uncomment the following to enable automatic server login
+#server=http://localhost
+#username=Admin
+#password=zabbix
 
 #Use the following to enable proxy server support
 #Only "proxy_server" is required to enable proxy support
@@ -10,6 +11,27 @@ password=zabbix
 #proxy_user=
 #proxy_password=
 
+#It is possible to define "named" servers and log into them individually
+#Named servers do not inherit any values from the global default server,
+#and will not be logged into at startup by default.
+#The syntax is a follows:
+#server[name][parameter]=value
+#"global" is reserved and cannot be used in the config file
+#The string "server" is required, and will not be part of the server name
+#in Zabcon.  At a minimum values are required for server,username and password
+#The following example would be referenced as "colo1" in Zabcon
+#server[colo1][server]=http://zabbix.example.com/zabbix
+#server[colo1][username]=Admin
+#server[colo1][password]=zabbix
+#server[colo1][proxy_server]=localhost
+#server[colo1][proxy_port]=3128
+#server[colo1][proxy_user]=user_proxy
+#server[colo1][proxy_password]=password
+
+#Which server will zabcon log into by default?
+#The gloabl keyword denotes the default unnamed server options above.
+#default_server=global
+
 # The following is a list of user editable config file options, the following
 # values are the defaults.  These can be changed as needed.
 

data/zabcon.rb

@@ -20,8 +20,8 @@
 
 ##########################################
 # Subversion information
-# $Id: zabcon.rb 370 2011-12-22 05:51:45Z nelsonab $
-# $Revision: 370 $
+# $Id: zabcon.rb 388 2012-04-23 07:45:29Z nelsonab $
+# $Revision: 388 $
 ##########################################
 
 #setup our search path or libraries
@@ -42,45 +42,31 @@ DEPENDENCIES={
   "parseconfig"=>true,
   "json"=>true,
   "highline"=>true,
-  "zbxapi"=>Gem::Version.new("0.1.369")
+  "zbxapi"=>Gem::Version.new("0.1.386")
 }
 
-
-required_rev=REQUIRED_RUBY_VER.split('.')
-ruby_rev=RUBY_VERSION.split('.')
-items=ruby_rev.length < required_rev.length ? ruby_rev.length : required_rev.length
-
-for i in 0..items-1 do
-  if ruby_rev[i].to_i<required_rev[i].to_i
-    puts
-    puts "Zabcon requires Ruby version #{required_rev.join('.')} or higher."
-    puts "you are using Ruby version #{RUBY_VERSION}."
-    puts
-    exit(1)
-  end
-  #If this step is higher than the required version break out of loop
-  break if ruby_rev[i].to_i>required_rev[i].to_i
+if Gem::Version.create(RUBY_VERSION) < Gem::Version.create(REQUIRED_RUBY_VER)
+  puts "Zabcon requires Ruby version #{REQUIRED_RUBY_VER} or higher."
+  puts "you are using Ruby version #{RUBY_VERSION}."
+  puts
+  exit(1)
 end
 
-
 depsok=true  #assume we will not fail dependencies
 
-DEPENDENCIES.each_key {|dep|
-  gem=Gem.source_index.find_name(dep)
-  if gem.empty?
-    puts " #{dep} : Not Installed"
+DEPENDENCIES.each do |pkg,ver|
+  begin
+    require pkg
+    if ver.is_a?(Gem::Version) && Gem.loaded_specs[pkg].version<ver
+      depsok=false
+      puts "Error: '#{pkg}' must be at least version #{ver.to_s} or higher, #{Gem.loaded_specs[pkg].version.to_s} installed"
+    end
+  rescue LoadError
     depsok=false
-    break
+    puts "Error: '#{pkg}' is a missing required dependency"
   end
-  gem.sort!{ |a,b| a.version <=> b.version }
-  depsok=depsok && !gem.map { |g|
-    if DEPENDENCIES[dep].class==Gem::Version && g.version<DEPENDENCIES[dep]
-      "#{dep} needs to be at least version #{DEPENDENCIES[dep]}, found #{g.version}"
-    else
+end
 
-    end
-  }.delete_if {|i| i==false}.empty?
-}
 if !depsok
   puts
   puts "One or more dependencies failed"
@@ -97,19 +83,23 @@ require 'ostruct'
 require 'strscan'
 require 'zbxapi/zdebug'
 require 'libs/zabcon_globals'
-
-if RUBY_VERSION=="1.8.6"  #Ruby 1.8.6 lacks the each_char function in the string object, so we add it here
-  String.class_eval do
-    def each_char
-      if block_given?
-        scan(/./m) do |x|
-          yield x
+require 'parseconfig'
+
+#Make any changes to base classes which are version specific
+case Gem::Version.create(RUBY_VERSION)
+  when Gem::Version.create("1.8.6")
+    #Ruby 1.8.6 lacks the each_char function in the string object, so we add it here
+    String.class_eval do
+      def each_char
+        if block_given?
+          scan(/./m) do |x|
+            yield x
+          end
+        else
+          scan(/./m)
         end
-      else
-        scan(/./m)
       end
     end
-  end
 end
 
 class ZabconApp
@@ -141,6 +131,12 @@ class ZabconApp
               "./zabcon.conf, ~/zabcon.conf in that","order") do |file|
         @cmd_opts.config_file=file
       end
+      opts.on("--no-login", "Do not automaticly log into Zabbix server on startup") do
+        @cmd_opts.no_login=true
+      end
+      opts.on("-S","--use-server SERVER","Log into the named server from the config file on startup") do |server|
+        @cmd_opts.default_server=server
+      end
       opts.on("--no-config", "Do not attempt to automatically load","the configuration file") do
         @cmd_opts.load_config=false
       end
@@ -189,6 +185,7 @@ class ZabconApp
     env["truncate_length"]=5000
     env["custom_commands"]=nil
     env["session_file"]="~/zabcon.session"
+    env["default_server"]="global"
 
     #output related environment variables
     env["table_output"]=STDIN.tty?   # Is the output a well formatted table, or csv like?
@@ -196,6 +193,71 @@ class ZabconApp
     env["table_separator"]=","
 
   end
+  #overrides is a hash of options which will override what is found in the config file.
+  #useful for command line options.
+  #if there is a hash called "config_file" this will override the default config file.
+  def load_config(overrides={})
+    begin
+      config_file = overrides["config_file"] || env["config_file"]
+
+      if config_file==:default
+        home_default=File::expand_path("~/zabcon.conf")
+        if File::exists?("zabcon.conf")
+          config_file="zabcon.conf"
+        elsif File::exists?(home_default)
+          config_file=home_default
+          env["config_file"]=home_default
+        else
+          raise "NoConfig"
+        end
+      end
+
+      config = overrides["load_config"]==false ?   # nil != false
+          {} : ParseConfig.new(config_file).params
+
+      # If we are not loading the config use an empty hash
+    rescue Errno::EACCES
+      if !(config_file=="zabcon.conf" and !File::exists?(config_file))
+        puts "Unable to access configuration file: #{config_file}"
+      end
+      config={}
+    rescue RuntimeError=>e
+      if e.message=="NoConfig"
+        puts "Unable to find a default configuration file"
+        config={}
+      else
+        raise e
+      end
+    end
+
+    config.merge!(overrides)  # merge the two option sets together but give precedence
+                              # to command line options
+
+    server_keys=["server","username","password","proxy_server",
+                "proxy_port","proxy_user","proxy_password"]
+
+    if !config.empty?
+      ServerCredentials.instance["global"]=config.select_keys(server_keys).merge({"name"=>"global"})
+      config.delete_keys(server_keys)
+    end
+
+    config.each_pair { |k,v|
+      if k.match(/(.+)\[(.+)\]\[(.+)\]/)
+        if $1.downcase=="server"
+          ServerCredentials.instance[$2] ||= {"name"=>$2}
+          ServerCredentials.instance[$2].merge!($3=>v)
+        else
+          env[$1] ||= {}
+          env[$1][$2] ||= {}
+          env[$1][$2].merge({$3=>v})
+        end
+      else
+        env[k]=v
+      end
+    }
+
+  end
+
 
   #checks to ensure all dependencies are available, forcefully exits with an
   # exit code of 1 if the dependency check fails
@@ -213,7 +275,7 @@ class ZabconApp
         cmd_hash[k.to_s]=v
       end
 
-      EnvVars.instance.load_config(cmd_hash)
+      load_config(cmd_hash)
 
     rescue OptionParser::InvalidOption  => e
       puts e