zabbirc 0.0.11 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af897ba02297f7617cf59c4e8e3566ad2dcadd1d
-  data.tar.gz: ca9355720c51cc0105dcc535392729a545a5bd78
+  metadata.gz: 0a9f3850b4563b9782a38dcef10d46b7afee95e7
+  data.tar.gz: 85a2a418b4db1d3793de71ac005178e16e538de5
 SHA512:
-  metadata.gz: 528f8d9b60be512037ff03aca50c6f0c2424e5ac830230260fb3e332d7d9de8ddbed2f4d8e3ab7137f490494937fe48acae3aecc615e38c38e319e9abb466205
-  data.tar.gz: 46e162cbaaf6d118fcf98cf7880d2fa77e753d6e0120b6ebc16efe5a4c3d634ca160869274424454e2a3c1f8c404f276e468cc16e9c84af9c0ba3934ce4f0690
+  metadata.gz: 1728b9299ba68cf8a68c6c85fee3fe2e36162e9cdf51ae3881841e4df09bae2ed2d63e3f3debabb8a904e32ac9fc549bd5c8820ea4a0b6e23bc4164271affc33
+  data.tar.gz: 5a142e7572ae5808c71cda5496528ff2a7aab66527131a715b911769b5d1a9dc682fb83310211c5a98d4c3aa1504a653b6497fb3a42936be796c394e8ea3cc18

data/lib/zabbirc/irc/base_command.rb

@@ -0,0 +1,120 @@
+module Zabbirc
+  module Irc
+    HELP_FEATURES = {}
+    class BaseCommand
+      def self.register_help command, description
+        raise ArgumentError, "command `#{command}` already registered" if HELP_FEATURES.key? command
+        HELP_FEATURES[command] = description
+      end
+
+      def help_features
+        HELP_FEATURES
+      end
+
+      attr_reader :op
+      def initialize ops, message, cmd
+        @ops = ops
+        @message = message
+        @op = get_op @message
+        @cmd = cmd.to_s.strip.gsub(/\s{2,}/," ")
+        @args = @cmd.split(/ /)
+      end
+
+      def run
+        return unless authenticated?
+        begin
+          perform # perform method should be implemented in subclass
+        rescue Zabbix::NotConnected => e
+          reply "#{e.to_s}"
+        rescue UserInputError => e
+          reply e.reply_messages
+        end
+      end
+
+      private
+
+      def authenticated?
+        @op.present?
+      end
+
+      def get_op obj
+        login = get_login obj
+        @ops.get login
+      end
+
+      def get_login obj
+        case obj
+        when Cinch::Message
+          obj.user.user.sub("~","")
+        when Cinch::User
+          obj.user.user.sub("~","")
+        when String
+          obj
+        else
+          # Used for tests
+          return obj.login if obj.respond_to? :login
+          return get_login(obj.user) if obj.respond_to? :user
+        end
+      end
+
+      def reply msg, *options
+        options = options.extract_options!.reverse_merge(prefix: "")
+        msg = Array.wrap msg
+        msg = msg.collect do |m|
+          "#{@op.nick}: #{options[:prefix]}#{m}"
+        end.join("\n")
+
+        @message.reply msg
+      end
+
+      def find_host host
+        hosts = Zabbix::Host.get(search: {host: host})
+        case hosts.size
+        when 0
+          reply "Host not found `#{host}`"
+        when 1
+          return hosts.first
+        when 2..10
+          reply "Found #{hosts.size} hosts: #{hosts.collect(&:name).join(', ')}. Be more specific"
+        else
+          reply "Found #{hosts.size} Be more specific"
+        end
+        false
+      end
+
+      def find_event short_eventid
+        begin
+          eventid = Zabbirc.events_id_shortener.get_id short_eventid
+          unless eventid
+            reply "Bad event id `#{short_eventid}`"
+            return false
+          end
+          event = Zabbix::Event.find(eventid, {selectHosts: :extend, selectRelatedObject: :extend})
+          if event.nil?
+            reply "Could not find event with id `#{short_eventid}`"
+            return false
+          end
+          event
+        rescue Zabbix::IDNotUniqueError => e
+          reply "Could not find event: #{e}"
+          false
+        end
+      end
+
+      def parse_priority priority
+        Priority.new(priority)
+      rescue ArgumentError => e
+        reply("#{e}")
+        nil
+      end
+    end
+
+    class UserInputError < StandardError
+
+      attr_reader :reply_messages
+      def initialize reply_messages
+        @reply_messages = reply_messages
+      end
+    end
+  end
+end

data/lib/zabbirc/irc/event_command.rb

@@ -0,0 +1,72 @@
+module Zabbirc
+  module Irc
+    class EventCommand < BaseCommand
+      register_help "events", "Show events from last #{Zabbirc.config.notify_about_events_from_last.to_i / 60} minutes filtered by <priority> and <host>. Usage: !events [<priority [<host>]]"
+      register_help "ack", "Acknowledges event with message. Usage: !ack <event-id> <ack-message>"
+      private
+      def perform
+        command = @args.shift
+        case command
+        when "events"
+          perform_events
+        when "ack"
+          perform_ack
+        end
+      end
+
+      def perform_events
+        priority = parse_priority(@args.shift || 0)
+        return unless priority
+        host = @args.join(" ")
+
+        events = Zabbix::Event.recent
+        events = events.select{|e| e.priority >= priority }
+        events = events.select{|e| e.any_host_matches? /#{host}/ } if host.present?
+        msg = if events.any?
+                events.collect do |e|
+                  "#{e.label}"
+                end
+              else
+                host_filter = host.present? ? " and host `#{host}`" : ""
+                "No last events for priority `#{priority}`#{host_filter}"
+              end
+        reply msg
+      end
+
+      def perform_ack
+        short_event_id = @args.shift
+        message = @args.join(" ")
+
+        if short_event_id.blank? or message.blank?
+          reply help_features["ack"]
+          return
+        end
+        event = find_event short_event_id
+        return unless event
+
+        if event.acknowledge "#{op.nick}: #{message}"
+          reply "Event `#{event.label}` acknowledged with message: #{message}"
+        else
+          reply "Could not acknowledge event `#{event.label}`"
+        end
+      end
+
+      def find_event short_eventid
+        eventid = Zabbirc.events_id_shortener.get_id short_eventid
+        unless eventid
+          reply "Bad event id `#{short_eventid}`"
+          return false
+        end
+        event = Zabbix::Event.find(eventid, {selectHosts: :extend, selectRelatedObject: :extend})
+        if event.nil?
+          reply "Could not find event with id `#{short_eventid}`"
+          return false
+        end
+        event
+      rescue Zabbix::IDNotUniqueError => e
+        reply "Could not find event: #{e}"
+        false
+      end
+    end
+  end
+end

data/lib/zabbirc/irc/help_command.rb

@@ -0,0 +1,20 @@
+module Zabbirc
+  module Irc
+    class HelpCommand < BaseCommand
+
+      private
+      def perform
+        command = @args.join(" ")
+        case command
+        when nil, ""
+          reply "Zabbirc - Zabbix IRC Bot - available commands: #{help_features.keys.join(", ")}. Type '!zabbirc help <command>' for detailed help"
+        when *help_features.keys
+          reply help_features[command], prefix: "HELP #{command}: "
+        else
+          reply "Unknown help command: #{command}"
+        end
+      end
+
+    end
+  end
+end

data/lib/zabbirc/irc/host_command.rb

@@ -0,0 +1,65 @@
+module Zabbirc
+  module Irc
+    class HostCommand < BaseCommand
+      register_help "status", "Show status of host. Usage: !status <hostname>"
+      register_help "latest", "Show last <N> (default 8) events of host. Usage: !latest <hostname> [<N>]"
+      private
+      def perform
+        @sub_command = @args.shift
+        case @sub_command
+        when "status"
+          perform_status
+        when "latest"
+          perform_latest
+        end
+      end
+
+      def host
+        @host ||= begin
+          hostname = @args.shift
+          if hostname.blank?
+            reply help_features[@sub_command]
+            return
+          end
+          find_host hostname
+        end
+      end
+
+      def perform_status
+        return unless host
+
+        triggers = Zabbix::Trigger.get(hostids: host.id, filter: {value: 1}, selectHosts: :extend)
+        triggers = triggers.sort{|x,y| x.priority <=> y.priority }
+        msg = ["Host: #{host.name}"]
+        if triggers.empty?
+          msg[0] << " - status: OK"
+        else
+          msg[0] << " - status: #{triggers.size} problems"
+          triggers.each do |trigger|
+            msg << "status: #{trigger.label}"
+          end
+        end
+        reply msg
+      end
+
+      def perform_latest
+        return unless host
+        limit = @args.shift
+        limit ||= 8
+
+        msg = ["Host: #{host.name}"]
+        events = Zabbix::Event.get(hostids: host.id, limit: limit, selectHosts: :extend, selectRelatedObject: :extend, sortfield: :clock, sortorder: "DESC")
+        if events.empty?
+          msg[0] << " - no events found"
+        else
+          msg[0] << " - showing last #{events.size} events"
+          events.each do |event|
+            msg << "!latest: #{event.label}"
+          end
+        end
+        reply msg
+      end
+
+    end
+  end
+end

data/lib/zabbirc/irc/plugin.rb

@@ -9,33 +9,19 @@ module Zabbirc
       listen_to :join, method: :sync_ops
       listen_to :leaving, method: :sync_ops
 
-      match /zabbirc help\s*$/, method: :zabbirc_help
-      match /zabbirc help (.+)\s*$/, method: :zabbirc_help_detail
       match /zabbirc status\s*$/, method: :zabbirc_status
 
+      # Help
+      match /(?:zabbirc help|help)(?: (.*))?\Z/, method: :help_command
+
       # Settings
-      register_help "settings", "Show your op specific settings. Usage: !settings"
-      match "settings", method: :show_settings
-      register_help "settings set", "Set your op specific settings. Usage: !setting set <setting-name> <setting-value>"
-      match /settings set ([#_a-zA-Z0-9]+)(?: ([#\-_a-zA-Z0-9]+))?/, method: :set_setting
-      match /(settings set)\s*$/, method: :zabbirc_help_detail
+      match /settings(?: (.*))?\Z/, method: :settings_command
 
       # Events
-      register_help "events", "Show events from last #{Zabbirc.config.notify_about_events_from_last.to_i / 60} minutes filtered by <priority> and <host>. Usage: !events [<priority [<host>]]"
-      match /events(?: ([a-zA-Z0-9\-]+)(?: ([a-zA-Z0-9\-]+))?)?\s*$/, method: :list_events
+      match /((?:ack|events)(?: .*)?)/, method: :event_command
 
       # Host
-      register_help "status", "Show status of host. Usage: !status <hostname>"
-      match /status ([a-zA-Z0-9\-.]+)/, method: :host_status
-      register_help "latest", "Show last <N> (default 8) events of host. Usage: !latest <hostname> [<N>]"
-      match /latest ([a-zA-Z0-9\-.]+)(?: (\d+))?/, method: :host_latest
-      match /(latest)\s*$/, method: :zabbirc_help_detail
-
-      # ACK
-      register_help "ack", "Acknowledges event with message. Usage: !ack <event-id> <ack-message>"
-      match /ack ([a-zA-Z0-9]+) (.*)/, method: :acknowledge_event
-      match /(ack)\s*$/, method: :zabbirc_help_detail
-      match /(ack) (?:[^ ]+)\s*$/, method: :zabbirc_help_detail
+      match /((?:status|latest)(?: .*)?)/, method: :host_command
     end
   end
 end

data/lib/zabbirc/irc/plugin_methods.rb

@@ -3,15 +3,15 @@ module Zabbirc
     module PluginMethods
       extend ActiveSupport::Concern
       include Help
-      extend Help::ClassMethods
 
       def zabbirc_status m
         ops_msg = ops.find_all{|o| o.nick.present? }.collect{|o| "#{o.nick} as #{o.login}"}
         msg = []
+        version = "Zabbirc #{Zabbirc::VERSION}"
         if Zabbix::Connection.test_connection
-          msg << "#{m.user.nick}: Zabbix API connection successfull"
+          msg << "#{m.user.nick}: #{version} - Zabbix API connection successfull"
         else
-          msg << "#{m.user.nick}: Zabbix API connection FAILED !!!"
+          msg << "#{m.user.nick}: #{version} - Zabbix API connection FAILED !!!"
         end
         msg << "#{m.user.nick}: Identified ops: #{ops_msg.join(", ")}"
         m.reply msg.join("\n")
@@ -19,63 +19,24 @@ module Zabbirc
         rescue_not_connected m, e
       end
 
-      def acknowledge_event m, eventid, message
-        op = authenticate m
-        return unless op
-        event = find_event m, eventid
-        return unless event
-
-        if event.acknowledge "#{op.nick}: #{message}"
-          m.reply "#{op.nick}: Event `#{event.label}` acknowledged with message: #{message}"
-        else
-          m.reply "#{op.nick}: Could not acknowledge event `#{event.label}`"
-        end
-      rescue Zabbix::NotConnected => e
-        rescue_not_connected m, e
+      def help_command m, cmd
+        cmd = HelpCommand.new(ops, m, cmd)
+        cmd.run
       end
 
-      def host_status m, host
-        op = authenticate m
-        return unless op
-        host = find_host m, host
-        return unless host
-
-        triggers = Zabbix::Trigger.get(hostids: host.id, filter: {value: 1}, selectHosts: :extend)
-        triggers = triggers.sort{|x,y| x.priority <=> y.priority }
-        msg = ["#{op.nick}: Host: #{host.name}"]
-        if triggers.empty?
-          msg[0] << " - status: OK"
-        else
-          msg[0] << " - status: #{triggers.size} problems"
-          triggers.each do |trigger|
-            msg << "#{op.nick}: status: #{trigger.label}"
-          end
-        end
-        m.reply msg.join("\n")
-      rescue Zabbix::NotConnected => e
-        rescue_not_connected m, e
+      def host_command m, cmd
+        cmd = HostCommand.new(ops, m, cmd)
+        cmd.run
       end
 
-      def host_latest m, host, limit
-        limit ||= 8
-        op = authenticate m
-        return unless op
-        host = find_host m, host
-        return unless host
+      def settings_command m, cmd
+        cmd = SettingsCommand.new(ops, m, cmd)
+        cmd.run
+      end
 
-        msg = ["#{op.nick}: Host: #{host.name}"]
-        events = Zabbix::Event.get(hostids: host.id, limit: limit, selectHosts: :extend, selectRelatedObject: :extend, sortfield: :clock, sortorder: "DESC")
-        if events.empty?
-          msg[0] << " - no events found"
-        else
-          msg[0] << " - showing last #{events.size} events"
-          events.each do |event|
-            msg << "#{op.nick}: !latest: #{event.label}"
-          end
-        end
-        m.reply msg.join("\n")
-      rescue Zabbix::NotConnected => e
-        rescue_not_connected m, e
+      def event_command m, cmd
+        cmd = EventCommand.new(ops, m, cmd)
+        cmd.run
       end
 
       def sync_ops m, u=nil
@@ -83,101 +44,6 @@ module Zabbirc
         bot.zabbirc_service.ops_service.iterate
       end
 
-      ### Settings
-      def show_settings m
-        op = authenticate m
-        return unless op
-        m.reply "#{op.nick}: #{op.setting}"
-      end
-
-      def set_setting m, key, value
-        op = authenticate m
-        return unless op
-        case key
-        when "notify", "notify_recoveries"
-          set_boolean m, op, key, value
-        when "events_priority"
-          set_events_priority m, op, value
-        when "primary_channel"
-          set_primary_channel m, op, value
-        else
-          m.reply "#{op.nick}: unknown setting `#{key}`"
-        end
-      end
-
-      def set_boolean m, op, key, value
-        if value.nil?
-          m.reply "#{op.nick}: #{key} allowed values: true, on, 1, false, off, 0"
-          return
-        end
-
-        case value
-        when "true", "on", "1"
-          op.setting.set key, true
-        when "false", "off", "0"
-          op.setting.set key, false
-        else
-          m.reply "#{op.nick}: uknown value `#{value}`. Allowed values: true, on, 1, false, off, 0"
-          return
-        end
-        m.reply "#{op.nick}: setting `#{key}` has been set to `#{op.setting.get key}`"
-      end
-
-      def set_events_priority m, op, value
-        if value.nil?
-          m.reply "#{op.nick}: events_priority allowed values: #{Priority::PRIORITIES.values.collect{|v| "`#{v}`"}.join(', ')} or numeric #{Priority::PRIORITIES.keys.join(", ")} "
-          return
-        end
-        begin
-          value = value.to_i if value =~ /^\d+$/
-          priority = Priority.new value
-        rescue ArgumentError
-          m.reply "#{op.nick}: uknown value `#{value}`. Allowed values: #{Priority::PRIORITIES.values.collect{|v| "`#{v}`"}.join(', ')} or numeric #{Priority::PRIORITIES.keys.join(", ")} "
-          return
-        end
-        op.setting.set :events_priority, priority.code
-        m.reply "#{op.nick}: setting `events_priority` has been set to `#{op.setting.get :events_priority}`"
-      end
-
-      def set_primary_channel m, op, value
-        channel_names = op.channels.collect(&:name)
-        if value.nil?
-          m.reply "#{op.nick}: notify allowed values: #{channel_names.join(", ")}"
-          return
-        end
-        case value
-        when *channel_names
-          op.setting.set :primary_channel, value
-        else
-          m.reply "#{op.nick}: uknown value `#{value}`. Allowed values: #{channel_names.join(", ")}"
-          return
-        end
-        m.reply "#{op.nick}: setting `primary_channel` has been set to `#{op.setting.get :primary_channel}`"
-      end
-
-      ### Events
-      def list_events m, priority=nil, host=nil
-        op = authenticate m
-        return unless op
-        priority = parse_priority(m, priority || 0)
-        return unless priority
-        
-        events = Zabbix::Event.recent
-        events = events.select{|e| e.priority >= priority }
-        events = events.select{|e| e.any_host_matches? /#{host}/ } if host
-        msg = if events.any?
-                events.collect do |e|
-                  "#{op.nick}: #{e.label}"
-                end.join("\n")
-              else
-                host_filter = host ? " and host `#{host}`" : ""
-                "#{op.nick}: No last events for priority `#{priority}`#{host_filter}"
-              end
-        m.reply msg
-      rescue Zabbix::NotConnected => e
-        rescue_not_connected m, e
-      end
-
       def ops
         @ops ||= bot.zabbirc_service.ops
       end
@@ -204,50 +70,6 @@ module Zabbirc
 
       private
 
-      def find_host m, host
-        op = get_op m
-        hosts = Zabbix::Host.get(search: {host: host})
-        case hosts.size
-        when 0
-          m.reply "#{op.nick}: Host not found `#{host}`"
-        when 1
-          return hosts.first
-        when 2..10
-          m.reply "#{op.nick}: Found #{hosts.size} hosts: #{hosts.collect(&:name).join(', ')}. Be more specific"
-        else
-          m.reply "#{op.nick}: Found #{hosts.size} Be more specific"
-        end
-        false
-      end
-
-      def find_event m, short_eventid
-        op = get_op m
-        begin
-          eventid = Zabbirc.events_id_shortener.get_id short_eventid
-          unless eventid
-            m.reply "#{op.nick}: Bad event id `#{short_eventid}`"
-            return false
-          end
-          event = Zabbix::Event.find(eventid, {selectHosts: :extend, selectRelatedObject: :extend})
-          if event.nil?
-            m.reply "#{op.nick} Could not find event with id `#{short_eventid}`"
-            return false
-          end
-          event
-        rescue Zabbix::IDNotUniqueError => e
-          m.reply "#{op.nick} Could not find event: #{e}"
-          false
-        end
-      end
-
-      def parse_priority m, priority
-        op = get_op m
-        Priority.new(priority)
-      rescue ArgumentError => e
-        m.reply("#{op.nick}: #{e}")
-        nil
-      end
-
       def rescue_not_connected m, e
         op = get_op m
         return unless op