zabcon 0.0.1

data/libs/printer.rb

@@ -0,0 +1,383 @@
+#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: printer.rb 258 2010-12-28 22:49:21Z nelsonab $
+# $Revision: 258 $
+##########################################
+
+require 'libs/zdebug'
+require 'libs/zabcon_globals'
+
+if RUBY_PLATFORM =~ /.*?mswin.*?/
+  require 'Win32API'
+
+  Kbhit = Win32API.new("crtdll", "_kbhit", 'V', 'L')
+  Getch = Win32API.new("crtdll", "_getch", 'V', 'L')
+
+  def getch
+    Getch.call
+  end
+
+  def kbhit
+    Kbhit.call
+  end
+end
+
+require 'highline/system_extensions'
+
+class OutputPrinter
+
+  include ZDebug
+  include HighLine::SystemExtensions
+
+  NILCHAR="--"
+
+#  attr_accessor :sheight
+
+  # Class initializer
+  # Interactive mode will not be implemented for a while so the variable
+  # is more of a place holder for now.  Interactive
+  def initialize(interactive=true)
+    @swidth=80                  # screen width
+    @interactive=interactive    # mode for output
+    @lines=0                    # how many lines have been displayed thus far?
+
+    # Check the environment variables to see if screen height has been set
+    EnvVars.instance["sheight"]=25 if EnvVars.instance["sheight"].nil?
+  end
+
+  def hash_width(item)
+    w=0
+    item.each do |value, index|
+      w+= value.length + index.length + 6   # 6 is for " => " and ", "
+    end
+    w-=2  # subtract out last comma and space
+    return w
+  end
+
+  def array_width(item)
+    w=0
+    item.each do |value|
+      w+=value.length + 2  # 2 is for ", "
+    end
+    w-=2  # remove last comma and space
+    return w
+  end
+
+  def getitemwidth(item)
+    retval=0
+    return NILCHAR.length if item.nil?
+    case item.class.to_s
+      when "String"
+        retval=item.length
+      when "Fixnum"
+        retval=item.to_s.length
+      when "Float"
+        retval=item.to_s.length
+      when "Hash"
+        retval=hash_width(item)
+      when "Array"
+        retval=array_width(item)
+      else
+        p item
+        raise "getitemwidth - item.class: #{item.class} not supported"
+    end
+    retval
+  end
+
+  # determines the max col width for each colum
+  # may need to be optimized in the future
+  # possible optimization may include randomly iterating through list for large lists
+  # if dataset is an array headers is ignored, also an integer is returned not an array
+  # of widths
+  def getcolwidth(dataset,headers=nil)
+    if dataset.class==Array then
+      widths=headers.collect {|x| 0}  # setup our resultant array of widths
+
+      # check the widths for the headers
+      headers.each_with_index { |value, index| widths[index] = value.length }
+
+      if (dataset.length>0) and (dataset[0].class!=Hash) then
+        width=0
+        dataset.each do |item|
+          w=getitemwidth(item)
+          widths[0] = widths[0]<w ? w : widths[0]    # 0 because there's one column
+        end
+        return widths
+      elsif dataset[0].class==Hash then
+        raise "getcolwidth headers are nil" if headers.nil?
+        dataset.each do |row|
+          headers.each_with_index do |value, index|
+            width=getitemwidth(row[value])
+            val= widths[index]  # storing value for efficiency, next statement might have two of this call
+            widths[index]= val < width ? width : val
+          end
+        end
+
+        return widths
+      else
+        raise "getcolwidth Unknown internal data type"
+      end
+    else
+      raise "getcolwidth - dataset type not supported: #{dataset.class}"  # need to raise an error
+    end
+  end
+
+  def format_hash_for_print(item)
+    s = ""
+    item.each do |value, index|
+      s << ", " if !s.empty?
+      s << index << " => " << value
+    end
+    return s
+  end
+
+  def format_for_print(item)
+    if item.nil? || item==[]
+      return NILCHAR
+    else
+      case item.class.to_s
+        when "Hash"
+          return format_hash_for_print(item)
+        else
+          return item
+      end
+    end
+  end
+
+  # Pause output function
+  # This function will pause output after n lines have been printed
+  # n is defined by the lines parameter
+  # If interactive output has been disabled pause will not stop
+  # after n lines have been printed
+  # If @lines is set to -1 a side effect is created where pause is disabled.
+  def pause? (lines=1)
+    if @interactive and EnvVars.instance["sheight"]>0 and (@lines>-1) then
+      @lines += lines
+      if @lines>=(EnvVars.instance["sheight"]-1) then
+        pause_msg = "Pause, q to quit, a to stop pausing output"
+        Kernel.print pause_msg
+        if RUBY_PLATFORM =~ /.*?mswin.*?/
+          while kbhit==0
+            sleep 0.3
+#            putc('.')
+          end
+          chr=getch
+          puts chr
+        else
+          begin
+            chr=get_character
+          rescue Interrupt  # trap ctrl-c and create side effect to behave like "q" was pressed
+            chr=113
+          end
+
+          # erase characters on the current line, and move the cursor left the size of pause_msg
+          Kernel.print "\033[2K\033[#{pause_msg.length}D"
+
+          if (chr==113) or (chr==81) then  # 113="q"  81="Q"
+            raise "quit"
+          end
+          if (chr==65) or (chr==97) then # 65="A"  97="a
+            @lines=-1
+          end
+        end
+        @lines= (@lines==-1) ? -1:0  # if we set @lines to -1 make sure the side effect propagates
+      end
+    end
+  end
+
+  def printline(widths)
+    output="+"
+    widths.each { |width| output+="-"+("-"*width)+"-+" }
+    pause? 1
+    puts output
+  end
+
+  #Prints the table header
+  #header: Array of strings in the print order for the table header
+  #order: Array of strings denoting output order
+  #widths: (optional) Array of numbers denoting the width of each field
+  #separator: (optional) Separator character
+  def printheader(header, widths=nil, separator=",")
+    if widths.nil?
+      output=""
+      header.each do |value|
+        output+="#{value}#{separator}"
+      end
+      separator.length.times {output.chop!}
+    else
+      output="|"
+      header.each_with_index do |value, index|
+        output+=" %-#{widths[index]}s |" % value
+      end
+    end
+    puts output
+    pause? 1
+  end
+
+  #Requires 2 arguments and 2 optional arguments
+  #row: The Row of data
+  #order: An array of field names with the order in which they are to be printed
+  #Optional arguments
+  #widths: An array denoting the width of each field, if nul a table separated by separator will be printed
+  #separator: the separator character to be used
+  def printrow(row, order, widths=nil, separator=',')
+    if widths.nil?
+      output=""
+      order.each_with_index do |value, index|
+        output+="#{row[value]}#{separator}"
+      end
+      separator.length.times { output.chop! }  #remove the last separator
+      puts output
+    else
+      output="|"
+      order.each_with_index do |value, index|
+        output+=" %-#{widths[index]}s |" % format_for_print(row[value])
+      end
+      puts output
+    end
+    pause? 1
+  end
+
+  def print_array(dataset,cols)
+    debug(6,dataset,"dataset",150)
+    debug(6,cols,"cols",50)
+    count=0
+    type=dataset[:class]
+    results=dataset[:result]
+
+    debug(6,type,"Array type")
+
+    puts "#{dataset[:class].to_s.capitalize} result set"  if EnvVars.instance["echo"]
+
+    if results.length==0
+      puts "Result set empty"
+    elsif results[0].class==Hash then
+      debug(7,"Results type is Hash")
+      header=[]
+      if cols.nil? then
+        case type
+          when :user
+            header=["userid","alias"]
+          when :host
+            header=["hostid","host"]
+          when :item
+            header=["itemid","description","key_"]
+          when :hostgroup
+            header=["groupid","name"]
+          when :hostgroupid
+            header=["name", "groupid", "internal"]
+          when :raw
+            header=results[0].keys
+          when nil
+            header=results[0].keys
+        end
+      elsif cols.class==Array
+        header=cols
+      elsif cols=="all" then
+        puts "all cols"
+        results[0].each_key { |key| header<<key }
+      else
+        header=cols.split(',')
+      end
+
+      debug(6,header,"header")
+
+      widths=getcolwidth(results,header)
+
+      if EnvVars.instance["table_output"]
+        if EnvVars.instance["table_header"]
+          printline(widths)
+          printheader(header,widths)
+        end
+        printline(widths)
+        results.each { |row| printrow(row,header,widths) }
+        printline(widths)
+        puts "#{results.length} rows total"
+      else
+        printheader(header,nil,EnvVars.instance["table_separator"]) if EnvVars.instance["table_header"]
+        results.each { | row| printrow(row,header,nil,EnvVars.instance["table_separator"]) }
+      end
+
+
+    else
+      debug(7,"Results type is not Hash, assuming array")
+      widths = getcolwidth(results,["id"])   # always returns an array of widths
+
+      printline(widths)            # hacking parameters to overload functions
+      printheader(["id"],widths)
+      printline(widths)
+
+      results.each { |item| printrow({"id"=>item},["id"],widths) }
+      printline(widths)
+      puts "#{results.length} rows total"
+    end
+  end
+
+  def print_hash(dataset,cols)
+    puts "Hash object printing not implemented, here is the raw result"
+    p dataset
+  end
+
+
+  def print(dataset,cols)
+    begin
+      debug(6,dataset,"Dataset",200)
+      debug(6,cols,"Cols",40)
+      @lines=0
+      if !cols   #cols==nil
+        cols_to_show=nil
+      else
+        cols_to_show=cols.empty? ? nil : cols[:show]
+      end
+    
+      puts dataset[:message] if dataset[:message]
+
+#    p dataset[:result].class
+      if dataset[:result].class==Array then
+        print_array(dataset,cols_to_show)
+      elsif dataset[:result].class==Hash then
+        print_hash(dataset,cols_to_show)
+      elsif dataset[:result].class!=NilClass then
+        puts "Unknown object received by the print routint"
+        puts "Class type: #{dataset[:result].class}"
+        puts "Data:"
+        p dataset[:result]
+      end
+    rescue TypeError
+      puts "***********************************************************"
+      puts "Whoops!"
+      puts "Looks like we got some data we didn't know how to print."
+      puts "This may be worth submitting as a bug.  If you submit a bug"
+      puts "report be sure to include this output and the command you"
+      puts "executed to get this message.  http://trac.red-tux.net"
+      puts "data received:"
+      p dataset
+    rescue RuntimeError => e
+      if e.message=="quit" then
+        puts "Output stopped"
+      else
+        raise e
+      end
+    end
+  end
+
+end

data/libs/zabcon_core.rb

@@ -0,0 +1,742 @@
+#!/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: $
+# $Revision: 258 $
+##########################################
+
+require 'parseconfig'
+require 'ostruct'
+require 'rexml/document'
+require 'libs/zbxcliserver'
+require 'libs/printer'
+require 'libs/zdebug'
+require 'libs/input'
+require 'libs/defines'
+require 'libs/command_tree'
+require 'libs/argument_processor'
+require 'libs/command_help'
+require 'libs/zabcon_globals'
+
+
+class ZabconCore
+
+  include ZDebug
+
+  def initialize()
+    @env = EnvVars.instance  # make it easier to call the global EnvVars singleton
+
+    # This must be set first or the debug module will throw an error
+    set_debug_level(@env["debug"])
+
+    @env.register_notifier("debug",self.method(:set_debug_level))
+    @env.register_notifier("api_debug",self.method(:set_debug_api_level))
+
+    @server = nil
+    @callbacks={}
+    @printer=OutputPrinter.new
+    @commands=nil
+    @setvars={}
+    debug(5,"Setting up help")
+    @cmd_help=CommandHelp.new("english")  # Setup help functions, determine default language to use
+    debug(5,"Setting up ArgumentProcessor")
+    @arg_processor=ArgumentProcessor.new  # Need to instantiate for debug routines
+
+    if !@env["server"].nil? and !@env["username"].nil? and !@env["password"].nil? then
+      puts "Found valid login credentials, attempting login"  if @env["echo"]
+      begin
+        do_login({:server=>@env["server"], :username=>@env["username"],:password=>@env["password"]})
+      rescue ZbxAPI_ExceptionLoginPermission
+        puts "Error Invalid login or no API permissions."
+      end
+    end
+
+    debug(5,"Setting up prompt")
+    @debug_prompt=false
+    if @env["have_tty"]
+      prc=Proc.new do
+        debug_part = @debug_prompt ? " #{debug_level}" : ""
+        if @server.nil?
+          " #{debug_part}-> "
+        else
+          @server.login? ? " #{debug_part}+> " : " #{debug_part}-> "
+        end
+      end
+      @input=Readline_Input.new
+      @input.set_prompt_func(prc)
+    else
+      @input=STDIN_Input.new
+    end
+    debug(5,"Setup complete")
+  end
+
+  # Argument logged in is used to determine which set of commands to load. If loggedin is true then commands which
+  # require a valid login are loaded
+  def setupcommands(loggedin)
+    debug(5,loggedin,"Starting setupcommands (loggedin)")
+
+    @commands=Parser.new(@arg_processor.default)
+
+    no_cmd=nil
+    no_args=nil
+    no_help=nil
+    no_verify=nil
+
+    login_required = lambda {
+      debug(6,"Lambda 'login_required'")
+      puts "Login required"
+      }
+
+    # parameters for insert:  insert_path, command, commandproc, arguments=[], helpproc=nil, verify_func=nil, options
+
+    # These commands do not require a valid login
+    @commands.insert "", "quit", :exit
+    @commands.insert "", "exit", :exit
+    @commands.insert "", "help", :help,no_args,no_help,@arg_processor.help, :suppress_printer
+
+    @commands.insert "", "hisotry", self.method(:do_history),no_args,no_help,no_verify,:suppress_printer
+    @commands.insert "", "info", self.method(:do_info),no_args,no_help,no_verify,:suppress_printer
+    @commands.insert "", "load", no_cmd,no_args,no_help,no_verify,:suppress_printer
+    @commands.insert "", "login", self.method(:do_login),nil,nil,@arg_processor.method(:login), :suppress_printer
+    @commands.insert "", "set", no_cmd
+    @commands.insert "", "show", no_cmd
+    @commands.insert "", "unset", no_cmd
+    @commands.insert "load", "config", @env.method(:load_config),no_args,no_help,no_verify,:suppress_printer
+    @commands.insert "set", "debug", self.method(:set_debug),no_args,no_help,no_verify,:suppress_printer
+    @commands.insert "set", "lines", self.method(:set_lines),no_args,no_help,no_verify,:suppress_printer
+    @commands.insert "set", "pause", self.method(:set_pause),no_args,no_help,no_verify,:suppress_printer
+    @commands.insert "set", "var", self.method(:set_var), no_args, no_help, @arg_processor.method(:simple_processor),:suppress_printer
+    @commands.insert "set", "env", self.method(:set_env), no_args, no_help, @arg_processor.method(:simple_processor), :suppress_printer
+    @commands.insert "show", "var", self.method(:show_var), no_args, no_help, @arg_processor.method(:array_processor), :suppress_printer
+    @commands.insert "show", "env", self.method(:show_env), no_args, no_help, @arg_processor.method(:array_processor), :suppress_printer
+    @commands.insert "unset", "var", self.method(:unset_var), no_args, no_help, @arg_processor.method(:array_processor), :suppress_printer
+
+    if loggedin then
+      debug(5,"Inserting commands which require login")
+      # This command tree is for a valid login
+      @commands.insert "", "raw", no_cmd
+      @commands.insert "", "add", no_cmd
+      @commands.insert "", "delete", no_cmd
+      @commands.insert "", "get", no_cmd, no_args, @cmd_help.method(:get)
+      @commands.insert "", "import", self.method(:do_import),no_args,no_help,no_verify
+      @commands.insert "", "update", no_cmd
+
+      @commands.insert "add", "app", @server.method(:addapp),no_args,no_help,no_verify
+      @commands.insert "add app", "id", @server.method(:getappid),no_args,no_help,no_verify
+      @commands.insert "add", "host", @server.method(:addhost), no_args, @cmd_help.method(:add_host), @arg_processor.method(:add_host), :server => @server
+      @commands.insert "add host", "group", @server.method(:addhostgroup),no_args,no_help,no_verify
+      @commands.insert "add", "item", @server.method(:additem), no_args, @cmd_help.method(:add_item), @arg_processor.method(:add_item)
+      @commands.insert "add", "link", @server.method(:addlink),no_args,no_help,no_verify
+      @commands.insert "add link", "trigger", @server.method(:addlinktrigger),no_args,no_help,no_verify
+      @commands.insert "add", "sysmap", @server.method(:addsysmap),no_args,no_help,no_verify
+      @commands.insert "add sysmap", "element", @server.method(:addelementtosysmap),no_args,no_help,no_verify
+      @commands.insert "add", "trigger", @server.method(:addtrigger),no_args,no_help,no_verify
+      @commands.insert "add", "user", @server.method(:adduser), no_args, @cmd_help.method(:add_user), @arg_processor.method(:add_user)
+      @commands.insert "add user", "media", @server.method(:addusermedia),no_args,@cmd_help.method(:add_user_media),no_verify
+
+      @commands.insert "get", "app", @server.method(:getapp), no_args, no_help, @arg_processor.default_get
+      @commands.insert "get", "host", @server.method(:gethost), no_args, no_help, @arg_processor.default_get
+      @commands.insert "get host", "group", @server.method(:gethostgroup), no_args, no_help, @arg_processor.default_get
+      @commands.insert "get host group", "id", @server.method(:gethostgroupid), no_args, no_help, @arg_processor.method(:get_group_id)
+      @commands.insert "get", "item", @server.method(:getitem),
+          ['itemids','hostids','groupids', 'triggerids','applicationids','status','templated_items','editable','count','pattern','limit','order', 'show'],
+          @cmd_help.method(:get_item), @arg_processor.default_get
+      @commands.insert "get", "seid", @server.method(:getseid), no_args, no_help, @arg_processor.default_get
+      @commands.insert "get", "trigger", @server.method(:gettrigger), no_args, no_help, @arg_processor.default_get
+      @commands.insert "get", "user", @server.method(:getuser),['show'], @cmd_help.method(:get_user), @arg_processor.method(:get_user)
+
+      @commands.insert "delete", "user", @server.method(:deleteuser), ['id'], @cmd_help.method(:delete_user), @arg_processor.method(:delete_user)
+      @commands.insert "delete", "host", @server.method(:deletehost), no_args, @cmd_help.method(:delete_host), @arg_processor.method(:delete_host)
+      @commands.insert "delete", "item", @server.method(:deleteitem), ['itemid'], @cmd_help.method(:delete_item), @arg_processor.default
+
+      @commands.insert "raw", "api", @server.method(:raw_api), no_args, @cmd_help.method(:raw_api), @arg_processor.method(:raw_api)
+      @commands.insert "raw", "json", @server.method(:raw_json), no_args, @cmd_help.method(:raw_json), @arg_processor.method(:raw_processor)
+
+      @commands.insert "update", "user", @server.method(:updateuser), no_args, no_help, no_verify
+    else
+      debug(5,"Inserting commands which do not require login")
+      # This command tree is for no login
+      @commands.insert "", "add", no_cmd
+      @commands.insert "", "delete", no_cmd
+      @commands.insert "", "get", no_cmd
+      @commands.insert "", "import", no_cmd,no_args,no_help
+      @commands.insert "", "update", no_cmd
+
+      @commands.insert "add", "app", login_required,no_args,no_help
+      @commands.insert "add app", "id", login_required,no_args,no_help
+      @commands.insert "add", "host", login_required, no_args, @cmd_help.method(:add_host)
+      @commands.insert "add host", "group", login_required,no_args,no_help
+      @commands.insert "add", "item", login_required, no_args, no_help
+      @commands.insert "add", "link", login_required,no_args,no_help
+      @commands.insert "add link", "trigger", login_required,no_args,no_help
+      @commands.insert "add", "sysmap", login_required,no_args,no_help
+      @commands.insert "add sysmap", "element", login_required,no_args,no_help
+      @commands.insert "add", "trigger", login_required,no_args,no_help
+      @commands.insert "add", "user", login_required, no_args, @cmd_help.method(:add_user)
+      @commands.insert "add user", "media", login_required,no_args,no_help
+
+      @commands.insert "get", "app", login_required, no_args, no_help
+      @commands.insert "get", "host", login_required, no_args, no_help
+      @commands.insert "get host", "group", login_required, no_args, no_help
+      @commands.insert "get host group", "id", login_required, no_args, no_help
+      @commands.insert "get", "item", login_required, no_args, no_help
+      @commands.insert "get", "seid", login_required, no_args, no_help
+      @commands.insert "get", "trigger", login_required, no_args, no_help
+      @commands.insert "get", "user", login_required,no_args, @cmd_help.method(:get_user)
+
+      @commands.insert "delete", "user", login_required, no_args, @cmd_help.method(:delete_user)
+      @commands.insert "delete", "host", login_required, no_args, @cmd_help.method(:delete_host)
+
+      @commands.insert "update", "user", login_required, no_args, no_help
+    end
+  end
+
+  def start
+    debug(5,"Entering main zabcon start routine")
+    puts "Welcome to Zabcon."  if @env["echo"]
+    puts "Use the command 'help' to get help on commands" if @env["have_tty"] || @env["echo"]
+
+    setupcommands(!@server.nil?)  # If we don't have a valid server we're not logged in'
+    begin
+      while line=@input.get_line()
+        line=@arg_processor.strip_comments(line)  # use the argument processor's comment stripper'
+        next if line.nil?
+        next if line.strip.length==0  # don't bother parsing an empty line'
+        debug(6, line, "Input from user")
+
+        # this statement calls the command tree parser and sets up rhash
+        # for later use and function calls
+        rhash=@commands.parse(line, @setvars)
+
+        debug(6, rhash, "Results from parse")
+
+        next if rhash.nil?
+        case rhash[:proc]
+          when :exit
+            break
+          when :help
+            @cmd_help.help(@commands,line)
+        else
+          if !rhash[:proc].nil?
+            debug(4,rhash,"Calling function",250)
+            results=rhash[:proc].call(rhash[:api_params])
+            printing = rhash[:options].nil? ? true : rhash[:options][:suppress_printer].nil? ? true : false
+            @printer.print(results,rhash[:show_params]) if !results.nil? if printing
+          end
+        end  # case
+
+      end  # while
+    rescue ParseError => e  #catch the base exception class
+      e.show_message
+      retry if e.retry?
+    rescue ZbxAPI_ExceptionVersion => e
+      puts e
+      retry  # We will allow for graceful recover from Version exceptions
+    rescue ZbxAPI_ExceptionLoginPermission
+      puts "No login permissions"
+      retry
+    rescue ZbxAPI_ExceptionPermissionError
+      puts "You do not have permission to perform that operation"
+      retry
+    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
+        e.show_message
+#        ddputs "Error: #{e.message}"
+        retry if e.retry?
+      end
+    rescue ZError => e
+      puts
+      if e.retry?
+        puts "A non-fatal error occurred."
+      else
+        puts "A fatal error occurred."
+      end
+      e.show_message
+      e.show_backtrace
+      retry if e.retry?
+    end  #end of exception block
+  end # def
+
+  def getprompt
+  debug_part = @debug_prompt ? " #{debug_level}" : ""
+  if @server.nil?
+      return " #{debug_part}-> "
+  end
+    return @server.login? ? " #{debug_part}+> " : " #{debug_part}-> "
+  end
+
+  def do_history(input)
+    history = @input.history.to_a
+    history.each_index do |index|
+      puts "#{index}: #{history[index]}"
+    end
+  end
+
+  # set_debug is for the callback to set the debug level
+  # todo
+  # This command is now deprecated for "set env debug=n"
+  def set_debug(input)
+    if input["prompt"].nil? then
+      puts "This command is deprecated, please use \"set env debug=n\""
+      @env["debug"]=input.keys[0].to_i
+    else
+      @debug_prompt=!@debug_prompt
+    end
+  end
+
+  def set_debug_api_level(value)
+    puts "inside set_debug_api_level"
+    set_facility_debug_level(:api,value)
+  end
+
+  def set_lines(input)
+    @printer.sheight=input.keys[0].to_i
+  end
+
+  def set_pause(input)
+    if input.nil? then
+      puts "set pause requires either Off or On"
+      return
+    end
+
+    if input.keys[0].upcase=="OFF"
+      @printer.sheight=@printer.sheight.abs*(-1)
+    elsif input.keys[0].upcase=="ON"
+      @printer.sheight=@printer.sheight.abs
+    else
+      puts "set pause requires either Off or On"
+    end
+    @printer.sheight = 24 if @printer.sheight==0
+  end
+
+  def set_var(input)
+    debug(6,input)
+    input.each {|key,val|
+      GlobalVars.instance[key]=val
+      puts "#{key} : #{val.inspect}"
+    }
+  end
+
+  def show_var(input)
+    if input.empty?
+      if GlobalVars.instance.empty?
+        puts "No variables defined"
+      else
+        GlobalVars.instance.each { |key,val|
+          puts "#{key} : #{val.inspect}"
+        }
+      end
+    else
+      input.each { |item|
+        if GlobalVars.instance[item].nil?
+          puts "#{item} *** Not Defined ***"
+        else
+          puts "#{item} : #{GlobalVars.instance[item].inspect}"
+        end
+      }
+    end
+  end
+
+  def unset_var(input)
+    if input.empty?
+      puts "No variables given to unset"
+    else
+      input.each {|item|
+        if GlobalVars.instance[item].nil?
+          puts "#{item} *** Not Defined ***"
+        else
+          GlobalVars.instance.delete(item)
+          puts "#{item} Deleted"
+        end
+      }
+    end
+  end
+
+  def set_env(input)
+    input.each{|key,val|
+      @env[key]=val
+      puts "#{key} : #{val.inspect}"
+    }
+  end
+
+  def show_env(input)
+    if input.empty?
+      if @env.empty?
+        puts "No variables defined"
+      else
+        @env.each { |key,val|
+          puts "#{key} : #{val.inspect}"
+        }
+      end
+    else
+      input.each { |item|
+        if @env[item].nil?
+          puts "#{item} *** Not Defined ***"
+        else
+          puts "#{item} : #{@env[item].inspect}"
+        end
+      }
+    end
+  end
+
+  # Load a configuration stored in a file
+  # many things can be passed in
+  # 1) an OpenStruct list of command line parameters which will overload the parameters
+  #    stored in the file
+  # 2) A Hash with a key :filename
+  # 3) If nil or empty the class variable @conffile will be used
+
+  def do_login(params)
+    url = params[:server]
+    username = params[:username]
+    password = params[:password]
+
+    begin
+      @server = ZbxCliServer.new(url,username,password,debug_level)
+      puts "#{url} connected"  if @env["echo"]
+      puts "API Version: #{@server.version}"  if @env["echo"]
+
+      setupcommands(true)
+      return true
+    rescue ZbxAPI_ExceptionBadAuth
+      puts "Login error, incorrect login information"
+      puts "Server: #{url}   User: #{username}  password: #{password}"   # will need to remove password in later versions
+      return false
+    rescue ZbxAPI_ExceptionBadServerUrl
+      puts "Login error, unable to connect to host or bad host name: '#{url}'"
+#    rescue ZbxAPI_ExceptionConnectionRefused
+#      puts "Server refused connection, is url correct?"
+    end
+  end
+
+  def do_info(input)
+    puts "Current settings"
+    puts "Server"
+    if @server.nil?
+      puts "Not connected"
+    else
+      puts " Server Name: %s" % @server.server_url
+      puts " Username: %-15s Password: %-12s" % [@server.user, Array.new(@server.password.length,'*')]
+    end
+    puts "Display"
+    puts " Current screen length #{@env["sheight"]}"
+    puts "Other"
+    puts " Debug level %d" % @env["debug"]
+  end
+
+#
+# Import config from an XML file:
+#
+  def do_import(input)
+    if input.nil?
+      puts "Run requires a file name as argument."
+      return
+    end
+
+    begin
+      xml_import = REXML::Document.new File.new(input[:filename])
+    rescue Errno::ENOENT
+      puts "Failed to open import file #{input[:filename]}."
+      return
+    end
+
+    if xml_import.nil?
+      puts "Failed to parse import file #{input[:filename]}."
+      return
+    end
+
+    host=xml_import.elements['import/hosts']
+    if !host.nil?
+      host = host[1]
+    end
+
+    # Loop for the host tags:
+    while !host.nil?
+      host_params = { 'host' => host.attributes["name"],
+                 'port' => host.elements["port"].text }
+      if host.elements["useip"].text.to_i == 0 # This is broken in Zabbix export (always 0).
+        host_params['dns']=host.elements["dns"].text
+      else
+        host_params['ip']=host.elements["ip"].text
+      end
+      # Loop through the groups:
+      group = host.elements['groups/']
+      if !group.nil?
+        group = group[1]
+      end
+      groupids = Array.new
+      while !group.nil?
+        result = @server.gethostgroupid({ 'name' => group.text })
+        groupid = result[:result].to_i
+        if groupid == 0
+          puts "The host group " + group.text + " doesn't exist. Attempting to add it."
+          result = @server.addhostgroup(['name' => group.text])
+          groupid = result[:result].to_a[0][1].to_i
+          if groupid == 0
+            puts "The group \"" + group.text + "\" doesn't exist and couldn't be added. Terminating import."
+            return
+          end
+        end
+        groupids << groupid
+        group = group.next_element
+      end
+      host_params['groupids'] = groupids;
+
+      # Add the host
+      result = @server.addhost(host_params)[:result]
+      hostid = @server.gethost( { 'pattern' => host.attributes['name'] } )[:result].to_a[0][1]
+      if result.nil? # Todo: result is nil when the host is added. I'm not sure if I buggered it up or not.
+        puts "Added host " + host.attributes['name'] + ": " + hostid.to_s
+      else
+        puts "Failed to add host " + host.attributes['name']
+      end
+
+      # Item loop (within host loop)
+      item = host.elements['items/']
+      if !item.nil?
+        item = item[1]
+        item_params = Array.new
+        appids = Array.new
+        while !item.nil?
+          # Application loop:
+          app = item.elements['applications/']
+          if !app.nil?
+            app = app[1]
+            if hostid != 0
+              while !app.nil?
+                appid = @server.getappid({'name' => app.text, 'hostid' => hostid})[:result]
+                if appid == 0
+                  result = @server.addapp([{'name' => app.text, 'hostid' => hostid}])
+                  appid = result[:result].to_a[0][1].to_i
+                  puts "Application " + app.text + " added: " + appid.to_s
+                end
+                appids << appid
+                app = app.next_element
+              end
+            else
+              puts "There is no hostname associated with the application " + app.text
+              puts "An application must be associated with a host. It has not been added."
+            end
+          end
+
+          item_params = { 'description'           => item.elements["description"].text,
+                          'key_'                  => item.attributes["key"],
+                          'hostid'                => hostid,
+                          'delay'                 => item.elements['delay'].text.to_s.to_i,
+                          'history'               => item.elements['history'].text.to_s.to_i,
+                          'status'                => item.elements['status'].text.to_s.to_i,
+                          'type'                  => item.attributes['type'].to_i,
+                          'snmp_community'        => item.elements['snmp_community'].text.to_s,
+                          'snmp_oid'              => item.elements['snmp_oid'].text.to_s,
+                          'value_type'            => item.attributes['value_type'].to_i,
+                          'data_type'             => item.elements['data_type'].text.to_s.to_i,
+                          'trapper_hosts'         => 'localhost',
+                          'snmp_port'             => item.elements['snmp_port'].text.to_s.to_i,
+                          'units'                 => item.elements['units'].text.to_s,
+                          'multiplier'            => item.elements['multiplier'].text.to_s.to_i,
+                          'delta'                 => item.elements['delta'].text.to_s.to_i,
+                          'snmpv3_securityname'   => item.elements['snmpv3_securityname'].text.to_s,
+                          'snmpv3_securitylevel'  => item.elements['snmpv3_securitylevel'].text.to_s.to_i,
+                          'snmpv3_authpassphrase' => item.elements['snmpv3_authpassphrase'].text.to_s,
+                          'snmpv3_privpassphrase' => item.elements['snmpv3_privpassphrase'].text.to_s,
+                          'formula'               => item.elements['formula'].text.to_s.to_i,
+                          'trends'                => item.elements['trends'].text.to_s.to_i,
+                          'logtimefmt'            => item.elements['logtimefmt'].text.to_s,
+                          'valuemapid'            => 0,
+                          'delay_flex'            => item.elements['delay_flex'].text.to_s,
+                          'params'                => item.elements['params'].text.to_s,
+                          'ipmi_sensor'           => item.elements['ipmi_sensor'].text.to_s.to_i,
+                          'applications'          => appids,
+                          'templateid'            => 0 }
+          added_item = @server.additem([item_params])
+          puts "Added item " + item.elements["description"].text + ": " + added_item[0]
+          item = item.next_element
+        end # End of item loop (within host loop)
+      end
+
+      host = host.next_element
+    end # End of loop for host tags
+
+    # Trigger loop
+    trigger=xml_import.elements['import/triggers']
+    if !trigger.nil?
+      trigger = trigger[1]
+    end
+    while !trigger.nil?
+      trigger_params = { 'description' => trigger.elements['description'].text,
+                         'type'        => trigger.elements['type'].text.to_i,
+                         'expression'  => trigger.elements['expression'].text,
+                         'url'         => '', # trigger.elements['url'].text,
+                         'status'      => trigger.elements['status'].text.to_i,
+                         'priority'    => trigger.elements['priority'].text.to_i,
+                         'comments'     => 'No comments.' } # trigger.elements['comments'].text }
+      result = @server.addtrigger( trigger_params )
+      puts "Added trigger " + result[:result][0]['triggerid'] + ": " + trigger.elements['description'].text
+      trigger = trigger.next_element
+    end
+
+    # Sysmap loop
+    sysmap = xml_import.elements['import/sysmaps/']
+    if !sysmap.nil?
+      sysmap = sysmap[1]
+    end
+    while !sysmap.nil?
+      sysmap_params = { 'name' => sysmap.attributes['name'],
+                        'width' => sysmap.elements['width'].text.to_i,
+                        'height' => sysmap.elements['height'].text.to_i,
+                        'backgroundid' => sysmap.elements['backgroundid'].text.to_i,
+                        'label_type' => sysmap.elements['label_type'].text.to_i,
+                        'label_location' => sysmap.elements['label_location'].text.to_i }
+      sysmapid = 0
+      result = @server.addsysmap([sysmap_params])
+      # Get sysmapid from the result code
+      sysmapid = result[:result][0]['sysmapid'].to_i
+      puts "Added sysmap " + sysmap.attributes['name'] + ": " + sysmapid.to_s
+
+      if sysmapid != 0 # We must have a sysmap ID to add elements
+
+        # Element loop (within the sysmap loop)
+        element = sysmap.elements['/import/sysmaps/sysmap/elements/']
+        if !element.nil?
+          element = element[1]
+        end
+        while !element.nil?
+          # Todo: change to use case.
+          elementtype = element.elements['elementtype'].text.to_i
+          if elementtype != ME_IMAGE
+            hostid = @server.gethost( { 'pattern' => element.elements['hostname'].text } )[:result].to_a[0][1].to_i
+          end
+          if elementtype == ME_HOST
+            elementid = hostid
+          elsif elementtype == ME_TRIGGER
+            elementid = @server.gettrigger({'hostids' => hostid, 'pattern' => element.elements['tdesc'].text})
+            elementid = elementid[:result].to_a[0][1].to_i
+          else # ME_IMAGE for now.
+            elementid = 0
+          end
+          element_params = { 'label' => element.attributes['label'],
+                             'sysmapid' => sysmapid,
+                             'elementid' => elementid,
+                             'elementtype' => element.elements['elementtype'].text.to_i,
+                             'iconid_off' => element.elements['iconid_off'].text.to_i,
+                             'iconid_on' => element.elements['iconid_on'].text.to_i,
+                             'iconid_unknown' => element.elements['iconid_unknown'].text.to_i,
+                             'iconid_disabled' => element.elements['iconid_disabled'].text.to_i,
+                             'label_location' => element.elements['label_location'].text.to_i,
+                             'x' => element.elements['x'].text.to_i,
+                             'y' => element.elements['y'].text.to_i }
+                             # 'url' => element.elements['url'].text }
+          result = @server.addelementtosysmap([element_params])
+          puts "Added map element " + element.attributes['label'] + ": " + result[:result]
+          element = element.next_element
+        end # End of element loop (within the sysmap loop)
+
+        # Sysmap link loop (within the sysmap loop)
+        syslink = sysmap.elements['/import/sysmaps/sysmap/sysmaplinks/']
+        if !syslink.nil?
+          syslink = syslink[1]
+        end
+        while !syslink.nil?
+          # The code down to "link_params = {" is a mess and needs to be rewritten.
+          # elementid = hostid or triggerid depending on element type.
+          if syslink.elements['type1'].text.to_i == ME_HOST
+            hostid1 = @server.gethost( { 'pattern' => syslink.elements['host1'].text } )[:result].to_a[0][1]
+            selementid1 = @server.getseid({'elementid' => hostid1, 'sysmapid' => sysmapid})[:result].to_a[0][1].to_i
+          elsif syslink.elements['type1'].text.to_i == ME_TRIGGER # The first element is a trigger
+            hostid1 = @server.gethost( { 'pattern' => syslink.elements['host1'].text } )[:result].to_a[0][1]
+            triggerid1 = @server.gettrigger({'hostids' => hostid1, 'pattern' => syslink.elements['tdesc1'].text})
+            hostid1 = triggerid1[:result].to_a[0][1].to_i
+            selementid1 = @server.getseid({'elementid' => hostid1, 'sysmapid' => sysmapid})[:result].to_a[0][1].to_i
+          elsif syslink.elements['type1'].text.to_i == ME_IMAGE
+            label = syslink.elements['label1'].text
+            selementid1 = @server.getseid({'label' => label, 'sysmapid' => sysmapid})[:result].to_a[0][1].to_i
+          end
+          # The other end of the link:
+          if syslink.elements['type2'].text.to_i == ME_HOST
+            hostid2 = @server.gethost( { 'pattern' => syslink.elements['host2'].text } )[:result].to_a[0][1]
+            selementid2 = @server.getseid({'elementid' => hostid2, 'sysmapid' => sysmapid})[:result].to_a[0][1].to_i
+          elsif syslink.elements['type2'].text.to_i == ME_TRIGGER # The second element is a trigger
+            hostid2 = @server.gethost( { 'pattern' => syslink.elements['host2'].text } )[:result].to_a[0][1]
+            triggerid2 = @server.gettrigger({'hostids' => hostid2, 'pattern' => syslink.elements['tdesc2'].text})
+            triggerid2 = triggerid2[:result].to_a[0][1].to_i
+            selementid2 = @server.getseid({'elementid' => triggerid2, 'sysmapid' => sysmapid})[:result].to_a[0][1].to_i
+          elsif syslink.elements['type2'].text.to_i == ME_IMAGE
+            label = syslink.elements['label2'].text
+            selementid2 = @server.getseid({'pattern' => label, 'sysmapid' => sysmapid})[:result].to_a[0][1].to_i
+          end
+          link_params = { 'sysmapid' => sysmapid,
+                          'selementid1' => selementid1,
+                          'selementid2' => selementid2,
+                          'triggers' => [], # The triggers require linkid, so this is a catch 22
+                          'drawtype' => syslink.elements['drawtype'].text.to_i,
+                          'color' => syslink.elements['color'].text.tr('"','') }
+          result = @server.addlink([link_params])
+          linkid = result[:result].to_i
+          puts "Link added: " + link_params.inspect
+          #puts "Added map link " + linkid.to_s + " (" + syslink.elements['host1'].text + "(" +
+          #     hostid1.to_s + ") <-> " + syslink.elements['host2'].text + "(" + hostid2.to_s + "))."
+
+          if !linkid.nil? # Link triggers require the associated link
+            # Sysmap link trigger loop (within the sysmap and syslink loop)
+            linktrigger = syslink.elements['linktriggers/']
+            if !linktrigger.nil?
+              linktrigger = linktrigger[1]
+            end
+            i = 0
+            linktrigger_params = Array.new
+            while !linktrigger.nil?
+              # Add hostname and tdesc field in the XML to identify the link:
+              hostid = @server.gethost( { 'pattern' => linktrigger.elements['host'].text } )[:result].to_a[0][1].to_i
+              triggerid = @server.gettrigger({'hostids' => hostid, 'pattern' => linktrigger.elements['tdesc'].text})
+              triggerid = triggerid[:result].to_a[0][1].to_i
+              if triggerid.nil?
+                puts "Failed to find trigger for host " + host + " and description \"" + tdesc + "\"."
+              else
+                linktrigger_params[i] = { 'linkid' => linkid,
+                                          'triggerid' => triggerid,
+                                          'drawtype' => linktrigger.elements['drawtype'].text.to_i,
+                                          'color' => linktrigger.elements['color'].text.tr('"', '') }
+                i = i + 1
+              end
+              linktrigger = linktrigger.next_element
+            end # End linktrigger loop (within sysmap and syslink loop)
+              puts "Adding link trigger(s): " + linktrigger_params.inspect
+              result = @server.addlinktrigger(linktrigger_params);
+          end # If !linkid.nil? (linktrigger)
+
+          syslink = syslink.next_element
+        end # End syslink loop
+
+      end # End If sysmap
+      sysmap = sysmap.next_element
+    end # End Sysmap loop
+
+  end # end do_import
+
+end #end class
+