zabcon 0.0.1

data/libs/zdebug.rb

@@ -0,0 +1,163 @@
+#License:: LGPL 2.1   http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
+#Copyright:: Copyright (C) 2009,2010 Andrew Nelson nelsonab(at)red-tux(dot)net
+#
+#This library is free software; you can redistribute it and/or
+#modify it under the terms of the GNU Lesser General Public
+#License as published by the Free Software Foundation; either
+#version 2.1 of the License, or (at your option) any later version.
+#
+#This library is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#Lesser General Public License for more details.
+#
+#You should have received a copy of the GNU Lesser General Public
+#License along with this library; if not, write to the Free Software
+#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+##########################################
+# Subversion information
+# $Id: zdebug.rb 222 2010-10-07 14:25:08Z nelsonab $
+# $Revision: 222 $
+##########################################
+
+module ZDebug
+
+  # Either set_debug_level or set_facility_debug_level must be called before
+  # the debug functions can be used.
+  def set_debug_level(level)   # sets the current debug level for printing messages
+    @@debug_level=level
+
+    # Create faciltiy_level if it's not created already
+    @@facility_level= {} if !defined?(@@facility_level)
+  end
+
+  # facility is a symbol, level is an integer
+  def set_facility_debug_level(facility,level)
+    # Create faciltiy_level if it's not created already
+    @@facility_level= {} if !defined?(@@facility_level)
+
+    @@facility_level[facility]=level
+
+    # Create debug level if it's not already created
+    @@debug_level=0 if !defined?(@@debug_level)
+  end
+
+  def debug_level
+    @@debug_level
+  end
+
+  # level - level to show message (Integer)
+  # variable - variable to show (Object)
+  # message - message to be prepended before variable  (String)
+  # overload - do show or error if debug_level is not set
+  def debug(level,variable="",message=nil,truncate=nil,overload=false)
+    return if overload
+    raise "Call set_debug before using debug" if !defined?(@@debug_level)
+    if level<=@@debug_level
+      #parse the caller array to determine who called us, what line, and what file
+      caller[0]=~/(.*):(\d+):.*`(.*?)'/
+
+      #sometimes the debug function gets called from within an exception block, in which cases the backtrace is not
+      #available.
+      file_tmp=$1.nil? ? "n/a" : $1
+      debug_line=$2.nil? ? "" : $2
+      debug_func=$3.nil? ? "" : $3
+      tmp_split=file_tmp.split("/")
+
+      if (len=tmp_split.length)>2
+        debug_file=".../#{tmp_split[len-2]}/#{tmp_split[len-1]}"
+      else
+        debug_file=file_tmp
+      end
+
+      strval=""
+      if variable.nil?
+        strval="nil"
+      elsif variable.class==String
+        strval=variable
+        if !truncate.nil?
+          if truncate<strval.length then
+            o_strval=strval
+            strval=o_strval[0..(truncate/2)]
+            strval+= "  .....  "
+            strval+=o_strval[(o_strval.length-(truncate/2))..o_strval.length]
+          end
+        end
+      else
+        strval=variable.inspect
+        if !truncate.nil?
+          if truncate<strval.length then
+            o_strval=strval
+            strval=o_strval[0..(truncate/2)]
+            strval+= "  .....  "
+            strval+=o_strval[(o_strval.length-(truncate/2))..o_strval.length]
+          end
+        end
+      end
+
+      if !message.nil?
+        strval = message + ": " + strval
+      end
+      puts "D#{level} #{debug_file}:#{debug_func}:#{debug_line} #{strval}"
+    end
+  end
+
+  # Debug_facility is a copy of the above function in an effort to shorten
+  # code path.
+  # facility - symbol denoting logging facility
+  # level - level to show message (Integer)
+  # variable - variable to show (Object)
+  # message - message to be prepended before variable  (String)
+  def debug_facility(facility,level,variable="",message=nil,truncate=nil)
+    facility_level=@@facility_level[facility]
+    raise "Call set_debug before using debug" if !defined?(@@debug_level)
+    raise "Unknown facility type: #{facility.to_s}" if facility_level.nil?
+    if level<=facility_level
+      #parse the caller array to determine who called us, what line, and what file
+      caller[0]=~/(.*):(\d+):.*`(.*?)'/
+
+      file_tmp=$1
+      debug_line=$2
+      debug_func=$3
+      tmp_split=file_tmp.split("/")
+
+      if (len=tmp_split.length)>2
+        debug_file=".../#{tmp_split[len-2]}/#{tmp_split[len-1]}"
+      else
+        debug_file=file_tmp
+      end
+
+      strval=""
+      if variable.nil?
+        strval="nil"
+      elsif variable.class==String
+        strval=variable
+        if !truncate.nil?
+          if truncate<strval.length then
+            o_strval=strval
+            strval=o_strval[0..(truncate/2)]
+            strval+= "  .....  "
+            strval+=o_strval[(o_strval.length-(truncate/2))..o_strval.length]
+          end
+        end
+      else
+        strval=variable.inspect
+        if !truncate.nil?
+          if truncate<strval.length then
+            o_strval=strval
+            strval=o_strval[0..(truncate/2)]
+            strval+= "  .....  "
+            strval+=o_strval[(o_strval.length-(truncate/2))..o_strval.length]
+          end
+        end
+      end
+
+      if !message.nil?
+        strval = message + ": " + strval
+      end
+      puts "D#{level}(#{facility.to_s}) #{debug_file}:#{debug_func}:#{debug_line} #{strval}"
+    end
+  end
+
+end  # end Debug module

data/zabcon.conf.default

@@ -0,0 +1,6 @@
+server=http://localhost
+username=admin
+password=zabbix
+lines=24
+debug=0
+language=english

data/zabcon.rb

@@ -0,0 +1,236 @@
+#!/usr/bin/ruby
+
+#GPL 2.0  http://www.gnu.org/licenses/gpl-2.0.html
+#Zabbix CLI Tool and associated files
+#Copyright (C) 2009,2010 Andrew Nelson nelsonab(at)red-tux(dot)net
+#
+#This program is free software; you can redistribute it and/or
+#modify it under the terms of the GNU General Public License
+#as published by the Free Software Foundation; either version 2
+#of the License, or (at your option) any later version.
+#
+#This program is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#GNU General Public License for more details.
+#
+#You should have received a copy of the GNU General Public License
+#along with this program; if not, write to the Free Software
+#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+##########################################
+# Subversion information
+# $Id: zabcon.rb 250 2010-12-24 06:56:38Z nelsonab $
+# $Revision: 250 $
+##########################################
+
+
+#setup our search path or libraries
+$: << File.expand_path(File.join(File.dirname(__FILE__), '.'))
+
+begin
+  require 'rubygems'
+rescue LoadError
+  puts
+  puts "Ruby Gems failed to load.  Please install Ruby Gems using your systems"
+  puts "package management program or downlaod it from http://rubygems.org."
+  puts
+  exit 1
+end
+
+require 'optparse'
+require 'ostruct'
+require 'libs/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
+        end
+      else
+        scan(/./m)
+      end
+    end
+  end
+end
+
+
+class ZabconApp
+
+  def initialize
+    setup_opt_parser
+  end
+
+  def setup_opt_parser
+    @cmd_opts=OpenStruct.new
+#    @options.debug=0
+
+
+    @opts = OptionParser.new do |opts|
+      opts.banner = "Usage: #{$0} [options] [command file]"
+      opts.separator "------------------------------------"
+      opts.separator ""
+      opts.separator "If command file is specified Zabcon will read from the file"
+      opts.separator "line by line and execute the commands in order.  If '-' is "
+      opts.separator "used, Zabcon will read from stdin as though it were a file."
+      opts.separator ""
+      opts.separator "Options"
+      opts.on("-h", "-?", "--help", "Display this help message") do
+        @cmd_opts.echo=false
+        @cmd_opts.help=true
+        puts opts
+      end
+      opts.on("-l", "--load FILE", "load configuration file supplied or ","default if none") do |file|
+        @cmd_opts.config_file=file
+      end
+      opts.on("--no-config", "Do not attempt to automatically load","the configuration file") do
+        @cmd_opts.load_config=false
+      end
+      opts.on("-d", "--debug LEVEL", Integer, "Specify debug level (Overrides config","file)") do |level|
+        @cmd_opts.debug=level
+      end
+      opts.on("-e", "--[no-]echo", "Enable startup echo.  Default is on ","for interactive") do |echo|
+        @cmd_opts.echo=echo
+      end
+      opts.on("-s", "--separator CHAR", "Seperator character for csv styple output.",
+              "Use \\t for tab separated output.") do |sep|
+        @cmd_opts.table_separator=sep
+      end
+      opts.on("--no-header", "Do not show headers on output.") do
+        @cmd_opts.table_header=false
+      end
+    end
+  end
+
+  def setup_globals
+    env=EnvVars.instance  # we must instantiate a singleton before using it
+    vars=GlobalVars.instance
+
+    env["debug"]=0
+    env["show_help"]=false
+    env["server"]=nil
+    env["username"]=nil
+    env["password"]=nil
+    env["lines"]=24
+    env["language"]="english"
+    env["logged_in"]=false
+    env["have_tty"]=STDIN.tty?
+    env["echo"]=STDIN.tty? ? true: false
+    env["config_file"]="zabcon.conf"
+    env["load_config"]=true
+
+    #output related environment variables
+    env["table_output"]=STDIN.tty?   # Is the output a well formatted table, or csv like?
+    env["table_header"]=true
+    env["table_separator"]=","
+
+  end
+
+  #checks to ensure all dependencies are available, forcefully exits with an
+  # exit code of 1 if the dependency check fails
+  # * ruby_rev is a string denoting the minimum version of ruby suitable
+  # * *dependencies is an array of libraries which are required
+  def check_dependencies(required_rev,*dependencies)
+    puts "Checking dependencies" if EnvVars.instance["echo"]
+    depsok=true  #assume we will not fail dependencies
+
+    required_rev=required_rev.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]<required_rev[i]
+        puts
+        puts "Zabcon requires Ruby version #{required_rev.join('.')} or higher."
+        puts "you are using Ruby version #{RUBY_VERSION}."
+        puts
+        exit(1)
+      elsif ruby_rev[i]>required_rev[i]
+        break
+      end
+    end
+
+    #Convert the inbound array to a hash
+    deps = Hash[*dependencies.collect { |v|
+      [v,true]
+    }.flatten]
+
+    deps.each_key {|dep|
+      val=Gem.source_index.find_name(dep).map {|x| x.name}==[]
+      puts " #{dep} : Not Installed" if val
+      depsok=false if val
+    }
+    if !depsok
+      puts
+      puts "One or more dependencies failed"
+      puts "Please see the dependencies file for instructions on installing the"
+      puts "required dependencies"
+      puts
+      exit(1)
+    end
+  end
+
+
+  def run
+    begin
+      setup_globals          # step 1, set up the global environment variables
+      @opts.parse!(ARGV)     # step 2, parse the command line and setup the class variable @cmd_opts
+
+      h = @cmd_opts.marshal_dump()  #dump the hash to a temporary variable
+      cmd_hash={}
+      h.each_pair do |k,v|
+        cmd_hash[k.to_s]=v
+      end
+      EnvVars.instance.load_config(cmd_hash)
+    rescue OptionParser::InvalidOption  => e
+      puts e
+      puts
+      puts @opts
+      exit(1)
+    rescue OptionParser::InvalidArgument => e
+      puts e
+      puts
+      puts @opts
+      exit(1)
+    rescue OptionParser::MissingArgument => e
+      puts e
+      puts
+      puts @opts
+      exit(1)
+    end
+
+    puts RUBY_PLATFORM if EnvVars.instance["echo"]
+
+    check_dependencies("1.8.6","parseconfig", "json", "highline")
+    #check_dependencies("0.0.0","parseconfig", "json", "highline")
+
+    begin
+      require 'readline'
+    rescue LoadError
+      puts "Readline support was not compiled into Ruby.  Readline support is required."
+      exit
+    end
+
+    #If we don't have the each_char method for the string class include the module that has it.
+    if !String.method_defined?("each_char")
+      begin
+        require 'jcode'
+      rescue LoadError
+        puts "Module jcode is required for your version of Ruby"
+      end
+    end
+
+    require 'libs/zabcon_core'   #Require placed after deps check
+
+    if @cmd_opts.help.nil?
+      zabcon=ZabconCore.new
+      zabcon.start()
+    end
+  end
+end
+
+zabconapp=ZabconApp.new()
+zabconapp.run()

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: zabcon
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- A. Nelson
+autorequire: 
+bindir: .
+cert_chain: []
+
+date: 2010-12-28 00:00:00 -05:00
+default_executable: zabcon
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: zbxapi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: parseconfig
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Zabcon is a command line interface for Zabbix written in Ruby
+email: nelsonab@red-tux.net
+executables: 
+- zabcon.rb
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- zabcon.rb
+- zabcon.conf.default
+- README
+- libs/argument_processor.rb
+- libs/command_help.rb
+- libs/command_tree.rb
+- libs/defines.rb
+- libs/exceptions.rb
+- libs/help.xml
+- libs/input.rb
+- libs/printer.rb
+- libs/zabcon_core.rb
+- libs/zabcon_exceptions.rb
+- libs/zabcon_globals.rb
+- libs/zbxcliserver.rb
+- libs/zdebug.rb
+- ./zabcon.rb
+has_rdoc: true
+homepage: http://trac.red-tux.net/
+licenses: 
+- LGPL 2.1
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- .
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- Requires zbxapi, parseconfig and highline
+rubyforge_project: zabcon
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Zabcon command line interface for Zabbix
+test_files: []
+